package smaws-clients

  1. Overview
  2. Docs
package smaws-clients
Legend:
Library
Module
Module type
Parameter
Class
Class type
type xks_proxy_vpc_endpoint_service_not_found_exception = {
  1. message : string option;
}
type xks_proxy_vpc_endpoint_service_invalid_configuration_exception = {
  1. message : string option;
}
type xks_proxy_vpc_endpoint_service_in_use_exception = {
  1. message : string option;
}
type xks_proxy_uri_unreachable_exception = {
  1. message : string option;
}
type xks_proxy_uri_in_use_exception = {
  1. message : string option;
}
type xks_proxy_uri_endpoint_in_use_exception = {
  1. message : string option;
}
type xks_proxy_invalid_response_exception = {
  1. message : string option;
}
type xks_proxy_invalid_configuration_exception = {
  1. message : string option;
}
type xks_proxy_incorrect_authentication_credential_exception = {
  1. message : string option;
}
type xks_proxy_connectivity_type =
  1. | VPC_ENDPOINT_SERVICE
  2. | PUBLIC_ENDPOINT
type xks_proxy_configuration_type = {
  1. vpc_endpoint_service_name : string option;
  2. uri_path : string option;
  3. uri_endpoint : string option;
  4. access_key_id : string option;
  5. connectivity : xks_proxy_connectivity_type option;
}
type xks_proxy_authentication_credential_type = {
  1. raw_secret_access_key : string;
  2. access_key_id : string;
}
type xks_key_not_found_exception = {
  1. message : string option;
}
type xks_key_invalid_configuration_exception = {
  1. message : string option;
}
type xks_key_configuration_type = {
  1. id : string option;
}
type xks_key_already_in_use_exception = {
  1. message : string option;
}
type wrapping_key_spec =
  1. | SM2
  2. | RSA_4096
  3. | RSA_3072
  4. | RSA_2048
type signing_algorithm_spec =
  1. | SM2DSA
  2. | ECDSA_SHA_512
  3. | ECDSA_SHA_384
  4. | ECDSA_SHA_256
  5. | RSASSA_PKCS1_V1_5_SHA_512
  6. | RSASSA_PKCS1_V1_5_SHA_384
  7. | RSASSA_PKCS1_V1_5_SHA_256
  8. | RSASSA_PSS_SHA_512
  9. | RSASSA_PSS_SHA_384
  10. | RSASSA_PSS_SHA_256
type verify_response = {
  1. signing_algorithm : signing_algorithm_spec option;
  2. signature_valid : bool option;
  3. key_id : string option;
}
type message_type =
  1. | DIGEST
  2. | RAW
type verify_request = {
  1. dry_run : bool option;
  2. grant_tokens : string list option;
  3. signing_algorithm : signing_algorithm_spec;
  4. signature : bytes;
  5. message_type : message_type option;
  6. message : bytes;
  7. key_id : string;
}
type mac_algorithm_spec =
  1. | HMAC_SHA_512
  2. | HMAC_SHA_384
  3. | HMAC_SHA_256
  4. | HMAC_SHA_224
type verify_mac_response = {
  1. mac_algorithm : mac_algorithm_spec option;
  2. mac_valid : bool option;
  3. key_id : string option;
}
type verify_mac_request = {
  1. dry_run : bool option;
  2. grant_tokens : string list option;
  3. mac : bytes;
  4. mac_algorithm : mac_algorithm_spec;
  5. key_id : string;
  6. message : bytes;
}
type not_found_exception = {
  1. message : string option;
}
type kms_invalid_state_exception = {
  1. message : string option;
}
type kms_invalid_mac_exception = {
  1. message : string option;
}
type kms_internal_exception = {
  1. message : string option;
}
type key_unavailable_exception = {
  1. message : string option;
}
type invalid_key_usage_exception = {
  1. message : string option;
}
type invalid_grant_token_exception = {
  1. message : string option;
}
type dry_run_operation_exception = {
  1. message : string option;
}
type disabled_exception = {
  1. message : string option;
}
type kms_invalid_signature_exception = {
  1. message : string option;
}
type dependency_timeout_exception = {
  1. message : string option;
}
type update_primary_region_request = {
  1. primary_region : string;
  2. key_id : string;
}
type unsupported_operation_exception = {
  1. message : string option;
}
type invalid_arn_exception = {
  1. message : string option;
}
type update_key_description_request = {
  1. description : string;
  2. key_id : string;
}
type update_custom_key_store_response = unit
type update_custom_key_store_request = {
  1. xks_proxy_connectivity : xks_proxy_connectivity_type option;
  2. xks_proxy_authentication_credential : xks_proxy_authentication_credential_type option;
  3. xks_proxy_vpc_endpoint_service_name : string option;
  4. xks_proxy_uri_path : string option;
  5. xks_proxy_uri_endpoint : string option;
  6. cloud_hsm_cluster_id : string option;
  7. key_store_password : string option;
  8. new_custom_key_store_name : string option;
  9. custom_key_store_id : string;
}
type custom_key_store_not_found_exception = {
  1. message : string option;
}
type custom_key_store_name_in_use_exception = {
  1. message : string option;
}
type custom_key_store_invalid_state_exception = {
  1. message : string option;
}
type cloud_hsm_cluster_not_found_exception = {
  1. message : string option;
}
type cloud_hsm_cluster_not_active_exception = {
  1. message : string option;
}
type cloud_hsm_cluster_invalid_configuration_exception = {
  1. message : string option;
}
type update_alias_request = {
  1. target_key_id : string;
  2. alias_name : string;
}
type limit_exceeded_exception = {
  1. message : string option;
}
type untag_resource_request = {
  1. tag_keys : string list;
  2. key_id : string;
}
type tag_exception = {
  1. message : string option;
}
type tag = {
  1. tag_value : string;
  2. tag_key : string;
}
type tag_resource_request = {
  1. tags : tag list;
  2. key_id : string;
}
type sign_response = {
  1. signing_algorithm : signing_algorithm_spec option;
  2. signature : bytes option;
  3. key_id : string option;
}
type sign_request = {
  1. dry_run : bool option;
  2. signing_algorithm : signing_algorithm_spec;
  3. grant_tokens : string list option;
  4. message_type : message_type option;
  5. message : bytes;
  6. key_id : string;
}
type key_state =
  1. | Updating
  2. | Unavailable
  3. | PendingReplicaDeletion
  4. | PendingImport
  5. | PendingDeletion
  6. | Disabled
  7. | Enabled
  8. | Creating
type schedule_key_deletion_response = {
  1. pending_window_in_days : int option;
  2. key_state : key_state option;
  3. deletion_date : float option;
  4. key_id : string option;
}
type schedule_key_deletion_request = {
  1. pending_window_in_days : int option;
  2. key_id : string;
}
type conflict_exception = {
  1. message : string option;
}
type rotate_key_on_demand_response = {
  1. key_id : string option;
}
type rotate_key_on_demand_request = {
  1. key_id : string;
}
type invalid_grant_id_exception = {
  1. message : string option;
}
type revoke_grant_request = {
  1. dry_run : bool option;
  2. grant_id : string;
  3. key_id : string;
}
type retire_grant_request = {
  1. dry_run : bool option;
  2. grant_id : string option;
  3. key_id : string option;
  4. grant_token : string option;
}
type malformed_policy_document_exception = {
  1. message : string option;
}
type already_exists_exception = {
  1. message : string option;
}
type key_usage_type =
  1. | KEY_AGREEMENT
  2. | GENERATE_VERIFY_MAC
  3. | ENCRYPT_DECRYPT
  4. | SIGN_VERIFY
type origin_type =
  1. | EXTERNAL_KEY_STORE
  2. | AWS_CLOUDHSM
  3. | EXTERNAL
  4. | AWS_KMS
type expiration_model_type =
  1. | KEY_MATERIAL_DOES_NOT_EXPIRE
  2. | KEY_MATERIAL_EXPIRES
type key_manager_type =
  1. | CUSTOMER
  2. | AWS
type customer_master_key_spec =
  1. | SM2
  2. | HMAC_512
  3. | HMAC_384
  4. | HMAC_256
  5. | HMAC_224
  6. | SYMMETRIC_DEFAULT
  7. | ECC_SECG_P256K1
  8. | ECC_NIST_P521
  9. | ECC_NIST_P384
  10. | ECC_NIST_P256
  11. | RSA_4096
  12. | RSA_3072
  13. | RSA_2048
type key_spec =
  1. | SM2
  2. | HMAC_512
  3. | HMAC_384
  4. | HMAC_256
  5. | HMAC_224
  6. | SYMMETRIC_DEFAULT
  7. | ECC_SECG_P256K1
  8. | ECC_NIST_P521
  9. | ECC_NIST_P384
  10. | ECC_NIST_P256
  11. | RSA_4096
  12. | RSA_3072
  13. | RSA_2048
type encryption_algorithm_spec =
  1. | SM2PKE
  2. | RSAES_OAEP_SHA_256
  3. | RSAES_OAEP_SHA_1
  4. | SYMMETRIC_DEFAULT
type key_agreement_algorithm_spec =
  1. | ECDH
type multi_region_key_type =
  1. | REPLICA
  2. | PRIMARY
type multi_region_key = {
  1. region : string option;
  2. arn : string option;
}
type multi_region_configuration = {
  1. replica_keys : multi_region_key list option;
  2. primary_key : multi_region_key option;
  3. multi_region_key_type : multi_region_key_type option;
}
type key_metadata = {
  1. xks_key_configuration : xks_key_configuration_type option;
  2. mac_algorithms : mac_algorithm_spec list option;
  3. pending_deletion_window_in_days : int option;
  4. multi_region_configuration : multi_region_configuration option;
  5. multi_region : bool option;
  6. key_agreement_algorithms : key_agreement_algorithm_spec list option;
  7. signing_algorithms : signing_algorithm_spec list option;
  8. encryption_algorithms : encryption_algorithm_spec list option;
  9. key_spec : key_spec option;
  10. customer_master_key_spec : customer_master_key_spec option;
  11. key_manager : key_manager_type option;
  12. expiration_model : expiration_model_type option;
  13. cloud_hsm_cluster_id : string option;
  14. custom_key_store_id : string option;
  15. origin : origin_type option;
  16. valid_to : float option;
  17. deletion_date : float option;
  18. key_state : key_state option;
  19. key_usage : key_usage_type option;
  20. description : string option;
  21. enabled : bool option;
  22. creation_date : float option;
  23. arn : string option;
  24. key_id : string;
  25. aws_account_id : string option;
}
type replicate_key_response = {
  1. replica_tags : tag list option;
  2. replica_policy : string option;
  3. replica_key_metadata : key_metadata option;
}
type replicate_key_request = {
  1. tags : tag list option;
  2. description : string option;
  3. bypass_policy_lockout_safety_check : bool option;
  4. policy : string option;
  5. replica_region : string;
  6. key_id : string;
}
type invalid_ciphertext_exception = {
  1. message : string option;
}
type incorrect_key_exception = {
  1. message : string option;
}
type re_encrypt_response = {
  1. destination_encryption_algorithm : encryption_algorithm_spec option;
  2. source_encryption_algorithm : encryption_algorithm_spec option;
  3. key_id : string option;
  4. source_key_id : string option;
  5. ciphertext_blob : bytes option;
}
type re_encrypt_request = {
  1. dry_run : bool option;
  2. grant_tokens : string list option;
  3. destination_encryption_algorithm : encryption_algorithm_spec option;
  4. source_encryption_algorithm : encryption_algorithm_spec option;
  5. destination_encryption_context : (string * string) list option;
  6. destination_key_id : string;
  7. source_key_id : string option;
  8. source_encryption_context : (string * string) list option;
  9. ciphertext_blob : bytes;
}
type put_key_policy_request = {
  1. bypass_policy_lockout_safety_check : bool option;
  2. policy : string;
  3. policy_name : string option;
  4. key_id : string;
}
type invalid_marker_exception = {
  1. message : string option;
}
type grant_operation =
  1. | DeriveSharedSecret
  2. | VerifyMac
  3. | GenerateMac
  4. | GenerateDataKeyPairWithoutPlaintext
  5. | GenerateDataKeyPair
  6. | DescribeKey
  7. | RetireGrant
  8. | CreateGrant
  9. | GetPublicKey
  10. | Verify
  11. | Sign
  12. | ReEncryptTo
  13. | ReEncryptFrom
  14. | GenerateDataKeyWithoutPlaintext
  15. | GenerateDataKey
  16. | Encrypt
  17. | Decrypt
type grant_constraints = {
  1. encryption_context_equals : (string * string) list option;
  2. encryption_context_subset : (string * string) list option;
}
type grant_list_entry = {
  1. constraints : grant_constraints option;
  2. operations : grant_operation list option;
  3. issuing_account : string option;
  4. retiring_principal : string option;
  5. grantee_principal : string option;
  6. creation_date : float option;
  7. name : string option;
  8. grant_id : string option;
  9. key_id : string option;
}
type list_grants_response = {
  1. truncated : bool option;
  2. next_marker : string option;
  3. grants : grant_list_entry list option;
}
type list_retirable_grants_request = {
  1. retiring_principal : string;
  2. marker : string option;
  3. limit : int option;
}
type list_resource_tags_response = {
  1. truncated : bool option;
  2. next_marker : string option;
  3. tags : tag list option;
}
type list_resource_tags_request = {
  1. marker : string option;
  2. limit : int option;
  3. key_id : string;
}
type key_list_entry = {
  1. key_arn : string option;
  2. key_id : string option;
}
type list_keys_response = {
  1. truncated : bool option;
  2. next_marker : string option;
  3. keys : key_list_entry list option;
}
type list_keys_request = {
  1. marker : string option;
  2. limit : int option;
}
type rotation_type =
  1. | ON_DEMAND
  2. | AUTOMATIC
type rotations_list_entry = {
  1. rotation_type : rotation_type option;
  2. rotation_date : float option;
  3. key_id : string option;
}
type list_key_rotations_response = {
  1. truncated : bool option;
  2. next_marker : string option;
  3. rotations : rotations_list_entry list option;
}
type list_key_rotations_request = {
  1. marker : string option;
  2. limit : int option;
  3. key_id : string;
}
type list_key_policies_response = {
  1. truncated : bool option;
  2. next_marker : string option;
  3. policy_names : string list option;
}
type list_key_policies_request = {
  1. marker : string option;
  2. limit : int option;
  3. key_id : string;
}
type list_grants_request = {
  1. grantee_principal : string option;
  2. grant_id : string option;
  3. key_id : string;
  4. marker : string option;
  5. limit : int option;
}
type alias_list_entry = {
  1. last_updated_date : float option;
  2. creation_date : float option;
  3. target_key_id : string option;
  4. alias_arn : string option;
  5. alias_name : string option;
}
type list_aliases_response = {
  1. truncated : bool option;
  2. next_marker : string option;
  3. aliases : alias_list_entry list option;
}
type list_aliases_request = {
  1. marker : string option;
  2. limit : int option;
  3. key_id : string option;
}
type invalid_import_token_exception = {
  1. message : string option;
}
type incorrect_key_material_exception = {
  1. message : string option;
}
type expired_import_token_exception = {
  1. message : string option;
}
type import_key_material_response = unit
type import_key_material_request = {
  1. expiration_model : expiration_model_type option;
  2. valid_to : float option;
  3. encrypted_key_material : bytes;
  4. import_token : bytes;
  5. key_id : string;
}
type get_public_key_response = {
  1. key_agreement_algorithms : key_agreement_algorithm_spec list option;
  2. signing_algorithms : signing_algorithm_spec list option;
  3. encryption_algorithms : encryption_algorithm_spec list option;
  4. key_usage : key_usage_type option;
  5. key_spec : key_spec option;
  6. customer_master_key_spec : customer_master_key_spec option;
  7. public_key : bytes option;
  8. key_id : string option;
}
type get_public_key_request = {
  1. grant_tokens : string list option;
  2. key_id : string;
}
type get_parameters_for_import_response = {
  1. parameters_valid_to : float option;
  2. public_key : bytes option;
  3. import_token : bytes option;
  4. key_id : string option;
}
type algorithm_spec =
  1. | SM2PKE
  2. | RSA_AES_KEY_WRAP_SHA_256
  3. | RSA_AES_KEY_WRAP_SHA_1
  4. | RSAES_OAEP_SHA_256
  5. | RSAES_OAEP_SHA_1
  6. | RSAES_PKCS1_V1_5
type get_parameters_for_import_request = {
  1. wrapping_key_spec : wrapping_key_spec;
  2. wrapping_algorithm : algorithm_spec;
  3. key_id : string;
}
type get_key_rotation_status_response = {
  1. on_demand_rotation_start_date : float option;
  2. next_rotation_date : float option;
  3. rotation_period_in_days : int option;
  4. key_id : string option;
  5. key_rotation_enabled : bool option;
}
type get_key_rotation_status_request = {
  1. key_id : string;
}
type get_key_policy_response = {
  1. policy_name : string option;
  2. policy : string option;
}
type get_key_policy_request = {
  1. policy_name : string option;
  2. key_id : string;
}
type generate_random_response = {
  1. ciphertext_for_recipient : bytes option;
  2. plaintext : bytes option;
}
type key_encryption_mechanism =
  1. | RSAES_OAEP_SHA_256
type recipient_info = {
  1. attestation_document : bytes option;
  2. key_encryption_algorithm : key_encryption_mechanism option;
}
type generate_random_request = {
  1. recipient : recipient_info option;
  2. custom_key_store_id : string option;
  3. number_of_bytes : int option;
}
type generate_mac_response = {
  1. key_id : string option;
  2. mac_algorithm : mac_algorithm_spec option;
  3. mac : bytes option;
}
type generate_mac_request = {
  1. dry_run : bool option;
  2. grant_tokens : string list option;
  3. mac_algorithm : mac_algorithm_spec;
  4. key_id : string;
  5. message : bytes;
}
type generate_data_key_without_plaintext_response = {
  1. key_id : string option;
  2. ciphertext_blob : bytes option;
}
type data_key_spec =
  1. | AES_128
  2. | AES_256
type generate_data_key_without_plaintext_request = {
  1. dry_run : bool option;
  2. grant_tokens : string list option;
  3. number_of_bytes : int option;
  4. key_spec : data_key_spec option;
  5. encryption_context : (string * string) list option;
  6. key_id : string;
}
type data_key_pair_spec =
  1. | SM2
  2. | ECC_SECG_P256K1
  3. | ECC_NIST_P521
  4. | ECC_NIST_P384
  5. | ECC_NIST_P256
  6. | RSA_4096
  7. | RSA_3072
  8. | RSA_2048
type generate_data_key_pair_without_plaintext_response = {
  1. key_pair_spec : data_key_pair_spec option;
  2. key_id : string option;
  3. public_key : bytes option;
  4. private_key_ciphertext_blob : bytes option;
}
type generate_data_key_pair_without_plaintext_request = {
  1. dry_run : bool option;
  2. grant_tokens : string list option;
  3. key_pair_spec : data_key_pair_spec;
  4. key_id : string;
  5. encryption_context : (string * string) list option;
}
type generate_data_key_pair_response = {
  1. ciphertext_for_recipient : bytes option;
  2. key_pair_spec : data_key_pair_spec option;
  3. key_id : string option;
  4. public_key : bytes option;
  5. private_key_plaintext : bytes option;
  6. private_key_ciphertext_blob : bytes option;
}
type generate_data_key_pair_request = {
  1. dry_run : bool option;
  2. recipient : recipient_info option;
  3. grant_tokens : string list option;
  4. key_pair_spec : data_key_pair_spec;
  5. key_id : string;
  6. encryption_context : (string * string) list option;
}
type generate_data_key_response = {
  1. ciphertext_for_recipient : bytes option;
  2. key_id : string option;
  3. plaintext : bytes option;
  4. ciphertext_blob : bytes option;
}
type generate_data_key_request = {
  1. dry_run : bool option;
  2. recipient : recipient_info option;
  3. grant_tokens : string list option;
  4. key_spec : data_key_spec option;
  5. number_of_bytes : int option;
  6. encryption_context : (string * string) list option;
  7. key_id : string;
}
type encrypt_response = {
  1. encryption_algorithm : encryption_algorithm_spec option;
  2. key_id : string option;
  3. ciphertext_blob : bytes option;
}
type encrypt_request = {
  1. dry_run : bool option;
  2. encryption_algorithm : encryption_algorithm_spec option;
  3. grant_tokens : string list option;
  4. encryption_context : (string * string) list option;
  5. plaintext : bytes;
  6. key_id : string;
}
type enable_key_rotation_request = {
  1. rotation_period_in_days : int option;
  2. key_id : string;
}
type enable_key_request = {
  1. key_id : string;
}
type disconnect_custom_key_store_response = unit
type disconnect_custom_key_store_request = {
  1. custom_key_store_id : string;
}
type disable_key_rotation_request = {
  1. key_id : string;
}
type disable_key_request = {
  1. key_id : string;
}
type describe_key_response = {
  1. key_metadata : key_metadata option;
}
type describe_key_request = {
  1. grant_tokens : string list option;
  2. key_id : string;
}
type connection_state_type =
  1. | DISCONNECTING
  2. | DISCONNECTED
  3. | FAILED
  4. | CONNECTING
  5. | CONNECTED
type connection_error_code_type =
  1. | XKS_PROXY_INVALID_TLS_CONFIGURATION
  2. | XKS_PROXY_TIMED_OUT
  3. | XKS_VPC_ENDPOINT_SERVICE_INVALID_CONFIGURATION
  4. | XKS_PROXY_INVALID_CONFIGURATION
  5. | XKS_PROXY_INVALID_RESPONSE
  6. | XKS_VPC_ENDPOINT_SERVICE_NOT_FOUND
  7. | XKS_PROXY_NOT_REACHABLE
  8. | XKS_PROXY_ACCESS_DENIED
  9. | INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET
  10. | SUBNET_NOT_FOUND
  11. | USER_LOGGED_IN
  12. | USER_NOT_FOUND
  13. | USER_LOCKED_OUT
  14. | INSUFFICIENT_CLOUDHSM_HSMS
  15. | INTERNAL_ERROR
  16. | NETWORK_ERRORS
  17. | CLUSTER_NOT_FOUND
  18. | INVALID_CREDENTIALS
type custom_key_store_type =
  1. | EXTERNAL_KEY_STORE
  2. | AWS_CLOUDHSM
type custom_key_stores_list_entry = {
  1. xks_proxy_configuration : xks_proxy_configuration_type option;
  2. custom_key_store_type : custom_key_store_type option;
  3. creation_date : float option;
  4. connection_error_code : connection_error_code_type option;
  5. connection_state : connection_state_type option;
  6. trust_anchor_certificate : string option;
  7. cloud_hsm_cluster_id : string option;
  8. custom_key_store_name : string option;
  9. custom_key_store_id : string option;
}
type describe_custom_key_stores_response = {
  1. truncated : bool option;
  2. next_marker : string option;
  3. custom_key_stores : custom_key_stores_list_entry list option;
}
type describe_custom_key_stores_request = {
  1. marker : string option;
  2. limit : int option;
  3. custom_key_store_name : string option;
  4. custom_key_store_id : string option;
}
type derive_shared_secret_response = {
  1. key_origin : origin_type option;
  2. key_agreement_algorithm : key_agreement_algorithm_spec option;
  3. ciphertext_for_recipient : bytes option;
  4. shared_secret : bytes option;
  5. key_id : string option;
}
type derive_shared_secret_request = {
  1. recipient : recipient_info option;
  2. dry_run : bool option;
  3. grant_tokens : string list option;
  4. public_key : bytes;
  5. key_agreement_algorithm : key_agreement_algorithm_spec;
  6. key_id : string;
}
type delete_imported_key_material_request = {
  1. key_id : string;
}
type custom_key_store_has_cm_ks_exception = {
  1. message : string option;
}
type delete_custom_key_store_response = unit
type delete_custom_key_store_request = {
  1. custom_key_store_id : string;
}
type delete_alias_request = {
  1. alias_name : string;
}
type decrypt_response = {
  1. ciphertext_for_recipient : bytes option;
  2. encryption_algorithm : encryption_algorithm_spec option;
  3. plaintext : bytes option;
  4. key_id : string option;
}
type decrypt_request = {
  1. dry_run : bool option;
  2. recipient : recipient_info option;
  3. encryption_algorithm : encryption_algorithm_spec option;
  4. key_id : string option;
  5. grant_tokens : string list option;
  6. encryption_context : (string * string) list option;
  7. ciphertext_blob : bytes;
}
type create_key_response = {
  1. key_metadata : key_metadata option;
}
type create_key_request = {
  1. xks_key_id : string option;
  2. multi_region : bool option;
  3. tags : tag list option;
  4. bypass_policy_lockout_safety_check : bool option;
  5. custom_key_store_id : string option;
  6. origin : origin_type option;
  7. key_spec : key_spec option;
  8. customer_master_key_spec : customer_master_key_spec option;
  9. key_usage : key_usage_type option;
  10. description : string option;
  11. policy : string option;
}
type create_grant_response = {
  1. grant_id : string option;
  2. grant_token : string option;
}
type create_grant_request = {
  1. dry_run : bool option;
  2. name : string option;
  3. grant_tokens : string list option;
  4. constraints : grant_constraints option;
  5. operations : grant_operation list;
  6. retiring_principal : string option;
  7. grantee_principal : string;
  8. key_id : string;
}
type incorrect_trust_anchor_exception = {
  1. message : string option;
}
type cloud_hsm_cluster_in_use_exception = {
  1. message : string option;
}
type create_custom_key_store_response = {
  1. custom_key_store_id : string option;
}
type create_custom_key_store_request = {
  1. xks_proxy_connectivity : xks_proxy_connectivity_type option;
  2. xks_proxy_authentication_credential : xks_proxy_authentication_credential_type option;
  3. xks_proxy_vpc_endpoint_service_name : string option;
  4. xks_proxy_uri_path : string option;
  5. xks_proxy_uri_endpoint : string option;
  6. custom_key_store_type : custom_key_store_type option;
  7. key_store_password : string option;
  8. trust_anchor_certificate : string option;
  9. cloud_hsm_cluster_id : string option;
  10. custom_key_store_name : string;
}
type invalid_alias_name_exception = {
  1. message : string option;
}
type create_alias_request = {
  1. target_key_id : string;
  2. alias_name : string;
}
type connect_custom_key_store_response = unit
type connect_custom_key_store_request = {
  1. custom_key_store_id : string;
}
type cancel_key_deletion_response = {
  1. key_id : string option;
}
type cancel_key_deletion_request = {
  1. key_id : string;
}
type base_document = Smaws_Lib.Json.t
val make_xks_proxy_configuration_type : ?vpc_endpoint_service_name:string -> ?uri_path:string -> ?uri_endpoint:string -> ?access_key_id:string -> ?connectivity:xks_proxy_connectivity_type -> unit -> xks_proxy_configuration_type
val make_xks_proxy_authentication_credential_type : raw_secret_access_key:string -> access_key_id:string -> unit -> xks_proxy_authentication_credential_type
val make_xks_key_configuration_type : ?id:string -> unit -> xks_key_configuration_type
val make_verify_response : ?signing_algorithm:signing_algorithm_spec -> ?signature_valid:bool -> ?key_id:string -> unit -> verify_response
val make_verify_request : ?dry_run:bool -> ?grant_tokens:string list -> ?message_type:message_type -> signing_algorithm:signing_algorithm_spec -> signature:bytes -> message:bytes -> key_id:string -> unit -> verify_request
val make_verify_mac_response : ?mac_algorithm:mac_algorithm_spec -> ?mac_valid:bool -> ?key_id:string -> unit -> verify_mac_response
val make_verify_mac_request : ?dry_run:bool -> ?grant_tokens:string list -> mac:bytes -> mac_algorithm:mac_algorithm_spec -> key_id:string -> message:bytes -> unit -> verify_mac_request
val make_update_primary_region_request : primary_region:string -> key_id:string -> unit -> update_primary_region_request
val make_update_key_description_request : description:string -> key_id:string -> unit -> update_key_description_request
val make_update_custom_key_store_response : unit -> update_custom_key_store_response
val make_update_custom_key_store_request : ?xks_proxy_connectivity:xks_proxy_connectivity_type -> ?xks_proxy_authentication_credential:xks_proxy_authentication_credential_type -> ?xks_proxy_vpc_endpoint_service_name:string -> ?xks_proxy_uri_path:string -> ?xks_proxy_uri_endpoint:string -> ?cloud_hsm_cluster_id:string -> ?key_store_password:string -> ?new_custom_key_store_name:string -> custom_key_store_id:string -> unit -> update_custom_key_store_request
val make_update_alias_request : target_key_id:string -> alias_name:string -> unit -> update_alias_request
val make_untag_resource_request : tag_keys:string list -> key_id:string -> unit -> untag_resource_request
val make_tag : tag_value:string -> tag_key:string -> unit -> tag
val make_tag_resource_request : tags:tag list -> key_id:string -> unit -> tag_resource_request
val make_sign_response : ?signing_algorithm:signing_algorithm_spec -> ?signature:bytes -> ?key_id:string -> unit -> sign_response
val make_sign_request : ?dry_run:bool -> ?grant_tokens:string list -> ?message_type:message_type -> signing_algorithm:signing_algorithm_spec -> message:bytes -> key_id:string -> unit -> sign_request
val make_schedule_key_deletion_response : ?pending_window_in_days:int -> ?key_state:key_state -> ?deletion_date:float -> ?key_id:string -> unit -> schedule_key_deletion_response
val make_schedule_key_deletion_request : ?pending_window_in_days:int -> key_id:string -> unit -> schedule_key_deletion_request
val make_rotate_key_on_demand_response : ?key_id:string -> unit -> rotate_key_on_demand_response
val make_rotate_key_on_demand_request : key_id:string -> unit -> rotate_key_on_demand_request
val make_revoke_grant_request : ?dry_run:bool -> grant_id:string -> key_id:string -> unit -> revoke_grant_request
val make_retire_grant_request : ?dry_run:bool -> ?grant_id:string -> ?key_id:string -> ?grant_token:string -> unit -> retire_grant_request
val make_multi_region_key : ?region:string -> ?arn:string -> unit -> multi_region_key
val make_multi_region_configuration : ?replica_keys:multi_region_key list -> ?primary_key:multi_region_key -> ?multi_region_key_type:multi_region_key_type -> unit -> multi_region_configuration
val make_key_metadata : ?xks_key_configuration:xks_key_configuration_type -> ?mac_algorithms:mac_algorithm_spec list -> ?pending_deletion_window_in_days:int -> ?multi_region_configuration:multi_region_configuration -> ?multi_region:bool -> ?key_agreement_algorithms:key_agreement_algorithm_spec list -> ?signing_algorithms:signing_algorithm_spec list -> ?encryption_algorithms:encryption_algorithm_spec list -> ?key_spec:key_spec -> ?customer_master_key_spec:customer_master_key_spec -> ?key_manager:key_manager_type -> ?expiration_model:expiration_model_type -> ?cloud_hsm_cluster_id:string -> ?custom_key_store_id:string -> ?origin:origin_type -> ?valid_to:float -> ?deletion_date:float -> ?key_state:key_state -> ?key_usage:key_usage_type -> ?description:string -> ?enabled:bool -> ?creation_date:float -> ?arn:string -> ?aws_account_id:string -> key_id:string -> unit -> key_metadata
val make_replicate_key_response : ?replica_tags:tag list -> ?replica_policy:string -> ?replica_key_metadata:key_metadata -> unit -> replicate_key_response
val make_replicate_key_request : ?tags:tag list -> ?description:string -> ?bypass_policy_lockout_safety_check:bool -> ?policy:string -> replica_region:string -> key_id:string -> unit -> replicate_key_request
val make_re_encrypt_response : ?destination_encryption_algorithm:encryption_algorithm_spec -> ?source_encryption_algorithm:encryption_algorithm_spec -> ?key_id:string -> ?source_key_id:string -> ?ciphertext_blob:bytes -> unit -> re_encrypt_response
val make_re_encrypt_request : ?dry_run:bool -> ?grant_tokens:string list -> ?destination_encryption_algorithm:encryption_algorithm_spec -> ?source_encryption_algorithm:encryption_algorithm_spec -> ?destination_encryption_context:(string * string) list -> ?source_key_id:string -> ?source_encryption_context:(string * string) list -> destination_key_id:string -> ciphertext_blob:bytes -> unit -> re_encrypt_request
val make_put_key_policy_request : ?bypass_policy_lockout_safety_check:bool -> ?policy_name:string -> policy:string -> key_id:string -> unit -> put_key_policy_request
val make_grant_constraints : ?encryption_context_equals:(string * string) list -> ?encryption_context_subset:(string * string) list -> unit -> grant_constraints
val make_grant_list_entry : ?constraints:grant_constraints -> ?operations:grant_operation list -> ?issuing_account:string -> ?retiring_principal:string -> ?grantee_principal:string -> ?creation_date:float -> ?name:string -> ?grant_id:string -> ?key_id:string -> unit -> grant_list_entry
val make_list_grants_response : ?truncated:bool -> ?next_marker:string -> ?grants:grant_list_entry list -> unit -> list_grants_response
val make_list_retirable_grants_request : ?marker:string -> ?limit:int -> retiring_principal:string -> unit -> list_retirable_grants_request
val make_list_resource_tags_response : ?truncated:bool -> ?next_marker:string -> ?tags:tag list -> unit -> list_resource_tags_response
val make_list_resource_tags_request : ?marker:string -> ?limit:int -> key_id:string -> unit -> list_resource_tags_request
val make_key_list_entry : ?key_arn:string -> ?key_id:string -> unit -> key_list_entry
val make_list_keys_response : ?truncated:bool -> ?next_marker:string -> ?keys:key_list_entry list -> unit -> list_keys_response
val make_list_keys_request : ?marker:string -> ?limit:int -> unit -> list_keys_request
val make_rotations_list_entry : ?rotation_type:rotation_type -> ?rotation_date:float -> ?key_id:string -> unit -> rotations_list_entry
val make_list_key_rotations_response : ?truncated:bool -> ?next_marker:string -> ?rotations:rotations_list_entry list -> unit -> list_key_rotations_response
val make_list_key_rotations_request : ?marker:string -> ?limit:int -> key_id:string -> unit -> list_key_rotations_request
val make_list_key_policies_response : ?truncated:bool -> ?next_marker:string -> ?policy_names:string list -> unit -> list_key_policies_response
val make_list_key_policies_request : ?marker:string -> ?limit:int -> key_id:string -> unit -> list_key_policies_request
val make_list_grants_request : ?grantee_principal:string -> ?grant_id:string -> ?marker:string -> ?limit:int -> key_id:string -> unit -> list_grants_request
val make_alias_list_entry : ?last_updated_date:float -> ?creation_date:float -> ?target_key_id:string -> ?alias_arn:string -> ?alias_name:string -> unit -> alias_list_entry
val make_list_aliases_response : ?truncated:bool -> ?next_marker:string -> ?aliases:alias_list_entry list -> unit -> list_aliases_response
val make_list_aliases_request : ?marker:string -> ?limit:int -> ?key_id:string -> unit -> list_aliases_request
val make_import_key_material_response : unit -> import_key_material_response
val make_import_key_material_request : ?expiration_model:expiration_model_type -> ?valid_to:float -> encrypted_key_material:bytes -> import_token:bytes -> key_id:string -> unit -> import_key_material_request
val make_get_public_key_response : ?key_agreement_algorithms:key_agreement_algorithm_spec list -> ?signing_algorithms:signing_algorithm_spec list -> ?encryption_algorithms:encryption_algorithm_spec list -> ?key_usage:key_usage_type -> ?key_spec:key_spec -> ?customer_master_key_spec:customer_master_key_spec -> ?public_key:bytes -> ?key_id:string -> unit -> get_public_key_response
val make_get_public_key_request : ?grant_tokens:string list -> key_id:string -> unit -> get_public_key_request
val make_get_parameters_for_import_response : ?parameters_valid_to:float -> ?public_key:bytes -> ?import_token:bytes -> ?key_id:string -> unit -> get_parameters_for_import_response
val make_get_parameters_for_import_request : wrapping_key_spec:wrapping_key_spec -> wrapping_algorithm:algorithm_spec -> key_id:string -> unit -> get_parameters_for_import_request
val make_get_key_rotation_status_response : ?on_demand_rotation_start_date:float -> ?next_rotation_date:float -> ?rotation_period_in_days:int -> ?key_id:string -> ?key_rotation_enabled:bool -> unit -> get_key_rotation_status_response
val make_get_key_rotation_status_request : key_id:string -> unit -> get_key_rotation_status_request
val make_get_key_policy_response : ?policy_name:string -> ?policy:string -> unit -> get_key_policy_response
val make_get_key_policy_request : ?policy_name:string -> key_id:string -> unit -> get_key_policy_request
val make_generate_random_response : ?ciphertext_for_recipient:bytes -> ?plaintext:bytes -> unit -> generate_random_response
val make_recipient_info : ?attestation_document:bytes -> ?key_encryption_algorithm:key_encryption_mechanism -> unit -> recipient_info
val make_generate_random_request : ?recipient:recipient_info -> ?custom_key_store_id:string -> ?number_of_bytes:int -> unit -> generate_random_request
val make_generate_mac_response : ?key_id:string -> ?mac_algorithm:mac_algorithm_spec -> ?mac:bytes -> unit -> generate_mac_response
val make_generate_mac_request : ?dry_run:bool -> ?grant_tokens:string list -> mac_algorithm:mac_algorithm_spec -> key_id:string -> message:bytes -> unit -> generate_mac_request
val make_generate_data_key_without_plaintext_response : ?key_id:string -> ?ciphertext_blob:bytes -> unit -> generate_data_key_without_plaintext_response
val make_generate_data_key_without_plaintext_request : ?dry_run:bool -> ?grant_tokens:string list -> ?number_of_bytes:int -> ?key_spec:data_key_spec -> ?encryption_context:(string * string) list -> key_id:string -> unit -> generate_data_key_without_plaintext_request
val make_generate_data_key_pair_without_plaintext_response : ?key_pair_spec:data_key_pair_spec -> ?key_id:string -> ?public_key:bytes -> ?private_key_ciphertext_blob:bytes -> unit -> generate_data_key_pair_without_plaintext_response
val make_generate_data_key_pair_without_plaintext_request : ?dry_run:bool -> ?grant_tokens:string list -> ?encryption_context:(string * string) list -> key_pair_spec:data_key_pair_spec -> key_id:string -> unit -> generate_data_key_pair_without_plaintext_request
val make_generate_data_key_pair_response : ?ciphertext_for_recipient:bytes -> ?key_pair_spec:data_key_pair_spec -> ?key_id:string -> ?public_key:bytes -> ?private_key_plaintext:bytes -> ?private_key_ciphertext_blob:bytes -> unit -> generate_data_key_pair_response
val make_generate_data_key_pair_request : ?dry_run:bool -> ?recipient:recipient_info -> ?grant_tokens:string list -> ?encryption_context:(string * string) list -> key_pair_spec:data_key_pair_spec -> key_id:string -> unit -> generate_data_key_pair_request
val make_generate_data_key_response : ?ciphertext_for_recipient:bytes -> ?key_id:string -> ?plaintext:bytes -> ?ciphertext_blob:bytes -> unit -> generate_data_key_response
val make_generate_data_key_request : ?dry_run:bool -> ?recipient:recipient_info -> ?grant_tokens:string list -> ?key_spec:data_key_spec -> ?number_of_bytes:int -> ?encryption_context:(string * string) list -> key_id:string -> unit -> generate_data_key_request
val make_encrypt_response : ?encryption_algorithm:encryption_algorithm_spec -> ?key_id:string -> ?ciphertext_blob:bytes -> unit -> encrypt_response
val make_encrypt_request : ?dry_run:bool -> ?encryption_algorithm:encryption_algorithm_spec -> ?grant_tokens:string list -> ?encryption_context:(string * string) list -> plaintext:bytes -> key_id:string -> unit -> encrypt_request
val make_enable_key_rotation_request : ?rotation_period_in_days:int -> key_id:string -> unit -> enable_key_rotation_request
val make_enable_key_request : key_id:string -> unit -> enable_key_request
val make_disconnect_custom_key_store_response : unit -> disconnect_custom_key_store_response
val make_disconnect_custom_key_store_request : custom_key_store_id:string -> unit -> disconnect_custom_key_store_request
val make_disable_key_rotation_request : key_id:string -> unit -> disable_key_rotation_request
val make_disable_key_request : key_id:string -> unit -> disable_key_request
val make_describe_key_response : ?key_metadata:key_metadata -> unit -> describe_key_response
val make_describe_key_request : ?grant_tokens:string list -> key_id:string -> unit -> describe_key_request
val make_custom_key_stores_list_entry : ?xks_proxy_configuration:xks_proxy_configuration_type -> ?custom_key_store_type:custom_key_store_type -> ?creation_date:float -> ?connection_error_code:connection_error_code_type -> ?connection_state:connection_state_type -> ?trust_anchor_certificate:string -> ?cloud_hsm_cluster_id:string -> ?custom_key_store_name:string -> ?custom_key_store_id:string -> unit -> custom_key_stores_list_entry
val make_describe_custom_key_stores_response : ?truncated:bool -> ?next_marker:string -> ?custom_key_stores:custom_key_stores_list_entry list -> unit -> describe_custom_key_stores_response
val make_describe_custom_key_stores_request : ?marker:string -> ?limit:int -> ?custom_key_store_name:string -> ?custom_key_store_id:string -> unit -> describe_custom_key_stores_request
val make_derive_shared_secret_response : ?key_origin:origin_type -> ?key_agreement_algorithm:key_agreement_algorithm_spec -> ?ciphertext_for_recipient:bytes -> ?shared_secret:bytes -> ?key_id:string -> unit -> derive_shared_secret_response
val make_derive_shared_secret_request : ?recipient:recipient_info -> ?dry_run:bool -> ?grant_tokens:string list -> public_key:bytes -> key_agreement_algorithm:key_agreement_algorithm_spec -> key_id:string -> unit -> derive_shared_secret_request
val make_delete_imported_key_material_request : key_id:string -> unit -> delete_imported_key_material_request
val make_delete_custom_key_store_response : unit -> delete_custom_key_store_response
val make_delete_custom_key_store_request : custom_key_store_id:string -> unit -> delete_custom_key_store_request
val make_delete_alias_request : alias_name:string -> unit -> delete_alias_request
val make_decrypt_response : ?ciphertext_for_recipient:bytes -> ?encryption_algorithm:encryption_algorithm_spec -> ?plaintext:bytes -> ?key_id:string -> unit -> decrypt_response
val make_decrypt_request : ?dry_run:bool -> ?recipient:recipient_info -> ?encryption_algorithm:encryption_algorithm_spec -> ?key_id:string -> ?grant_tokens:string list -> ?encryption_context:(string * string) list -> ciphertext_blob:bytes -> unit -> decrypt_request
val make_create_key_response : ?key_metadata:key_metadata -> unit -> create_key_response
val make_create_key_request : ?xks_key_id:string -> ?multi_region:bool -> ?tags:tag list -> ?bypass_policy_lockout_safety_check:bool -> ?custom_key_store_id:string -> ?origin:origin_type -> ?key_spec:key_spec -> ?customer_master_key_spec:customer_master_key_spec -> ?key_usage:key_usage_type -> ?description:string -> ?policy:string -> unit -> create_key_request
val make_create_grant_response : ?grant_id:string -> ?grant_token:string -> unit -> create_grant_response
val make_create_grant_request : ?dry_run:bool -> ?name:string -> ?grant_tokens:string list -> ?constraints:grant_constraints -> ?retiring_principal:string -> operations:grant_operation list -> grantee_principal:string -> key_id:string -> unit -> create_grant_request
val make_create_custom_key_store_response : ?custom_key_store_id:string -> unit -> create_custom_key_store_response
val make_create_custom_key_store_request : ?xks_proxy_connectivity:xks_proxy_connectivity_type -> ?xks_proxy_authentication_credential:xks_proxy_authentication_credential_type -> ?xks_proxy_vpc_endpoint_service_name:string -> ?xks_proxy_uri_path:string -> ?xks_proxy_uri_endpoint:string -> ?custom_key_store_type:custom_key_store_type -> ?key_store_password:string -> ?trust_anchor_certificate:string -> ?cloud_hsm_cluster_id:string -> custom_key_store_name:string -> unit -> create_custom_key_store_request
val make_create_alias_request : target_key_id:string -> alias_name:string -> unit -> create_alias_request
val make_connect_custom_key_store_response : unit -> connect_custom_key_store_response
val make_connect_custom_key_store_request : custom_key_store_id:string -> unit -> connect_custom_key_store_request
val make_cancel_key_deletion_response : ?key_id:string -> unit -> cancel_key_deletion_response
val make_cancel_key_deletion_request : key_id:string -> unit -> cancel_key_deletion_request
module VerifyMac : sig ... end
module Verify : sig ... end
module UpdatePrimaryRegion : sig ... end
module UpdateKeyDescription : sig ... end
module UpdateCustomKeyStore : sig ... end
module UpdateAlias : sig ... end
module UntagResource : sig ... end
module TagResource : sig ... end
module Sign : sig ... end
module ScheduleKeyDeletion : sig ... end
module RotateKeyOnDemand : sig ... end
module RevokeGrant : sig ... end
module RetireGrant : sig ... end
module ReplicateKey : sig ... end
module ReEncrypt : sig ... end
module PutKeyPolicy : sig ... end
module ListRetirableGrants : sig ... end
module ListResourceTags : sig ... end
module ListKeys : sig ... end
module ListKeyRotations : sig ... end
module ListKeyPolicies : sig ... end
module ListGrants : sig ... end
module ListAliases : sig ... end
module ImportKeyMaterial : sig ... end
module GetPublicKey : sig ... end
module GetParametersForImport : sig ... end
module GetKeyRotationStatus : sig ... end
module GetKeyPolicy : sig ... end
module GenerateRandom : sig ... end
module GenerateMac : sig ... end
module GenerateDataKeyWithoutPlaintext : sig ... end
module GenerateDataKeyPair : sig ... end
module GenerateDataKey : sig ... end
module Encrypt : sig ... end
module EnableKeyRotation : sig ... end
module EnableKey : sig ... end
module DisconnectCustomKeyStore : sig ... end
module DisableKeyRotation : sig ... end
module DisableKey : sig ... end
module DescribeKey : sig ... end
module DescribeCustomKeyStores : sig ... end
module DeriveSharedSecret : sig ... end
module DeleteImportedKeyMaterial : sig ... end
module DeleteCustomKeyStore : sig ... end
module DeleteAlias : sig ... end
module Decrypt : sig ... end
module CreateKey : sig ... end
module CreateGrant : sig ... end
module CreateCustomKeyStore : sig ... end
module CreateAlias : sig ... end
module ConnectCustomKeyStore : sig ... end
module CancelKeyDeletion : sig ... end
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct