Module Smaws_Client_PaymentCryptography

Payment Cryptography client library built on EIO.

Types

module Types : sig ... end

Builders

val make_wrapped_key : ?key_check_value_algorithm:Types.key_check_value_algorithm -> ?key_check_value:Types.key_check_value -> key_material:Types.key_material -> wrapped_key_material_format:Types.wrapped_key_material_format -> wrapping_key_arn:Types.key_arn -> unit -> Types.wrapped_key
val make_alias : ?key_arn:Types.key_arn -> alias_name:Types.alias_name -> unit -> Types.alias
val make_update_alias_output : alias:Types.alias -> unit -> Types.update_alias_output
val make_update_alias_input : ?key_arn:Types.key_arn -> alias_name:Types.alias_name -> unit -> Types.update_alias_input
val make_untag_resource_output : unit -> unit
val make_untag_resource_input : tag_keys:Types.tag_keys -> resource_arn:Types.resource_arn -> unit -> Types.untag_resource_input
val make_key_attributes : key_modes_of_use:Types.key_modes_of_use -> key_algorithm:Types.key_algorithm -> key_class:Types.key_class -> key_usage:Types.key_usage -> unit -> Types.key_attributes
val make_trusted_certificate_public_key : certificate_authority_public_key_identifier:Types.key_arn_or_key_alias_type -> public_key_certificate:Types.certificate_type -> key_attributes:Types.key_attributes -> unit -> Types.trusted_certificate_public_key
val make_tag : value:Types.tag_value -> key:Types.tag_key -> unit -> Types.tag
val make_tag_resource_output : unit -> unit
val make_tag_resource_input : tags:Types.tags -> resource_arn:Types.resource_arn -> unit -> Types.tag_resource_input
val make_replication_status_type : ?status_message:Smaws_Lib.Smithy_api.Types.string_ -> status:Types.key_replication_state -> unit -> Types.replication_status_type
val make_mpa_status : ?status_message:Types.mpa_status_message -> initiation_date:Types.timestamp -> status:Types.session_status -> mpa_session_arn:Types.mpa_session_arn -> unit -> Types.mpa_status
val make_key : ?mpa_status:Types.mpa_status -> ?using_default_replication_regions:Smaws_Lib.Smithy_api.Types.boolean_ -> ?replication_status:Types.replication_status -> ?primary_region:Types.region -> ?multi_region_key_type:Types.multi_region_key_type -> ?derive_key_usage:Types.derive_key_usage -> ?delete_timestamp:Types.timestamp -> ?delete_pending_timestamp:Types.timestamp -> ?usage_stop_timestamp:Types.timestamp -> ?usage_start_timestamp:Types.timestamp -> create_timestamp:Types.timestamp -> key_origin:Types.key_origin -> key_state:Types.key_state -> exportable:Smaws_Lib.Smithy_api.Types.boolean_ -> enabled:Smaws_Lib.Smithy_api.Types.boolean_ -> key_check_value_algorithm:Types.key_check_value_algorithm -> key_check_value:Types.key_check_value -> key_attributes:Types.key_attributes -> key_arn:Types.key_arn -> unit -> Types.key
val make_stop_key_usage_output : key:Types.key -> unit -> Types.stop_key_usage_output
val make_stop_key_usage_input : key_identifier:Types.key_arn_or_key_alias_type -> unit -> Types.stop_key_usage_input
val make_start_key_usage_output : key:Types.key -> unit -> Types.start_key_usage_output
val make_start_key_usage_input : key_identifier:Types.key_arn_or_key_alias_type -> unit -> Types.start_key_usage_input
val make_root_certificate_public_key : public_key_certificate:Types.certificate_type -> key_attributes:Types.key_attributes -> unit -> Types.root_certificate_public_key
val make_restore_key_output : key:Types.key -> unit -> Types.restore_key_output
val make_restore_key_input : key_identifier:Types.key_arn_or_key_alias_type -> unit -> Types.restore_key_input
val make_remove_key_replication_regions_output : key:Types.key -> unit -> Types.remove_key_replication_regions_output
val make_remove_key_replication_regions_input : replication_regions:Types.regions -> key_identifier:Types.key_arn_or_key_alias_type -> unit -> Types.remove_key_replication_regions_input
val make_put_resource_policy_output : policy:Types.resource_policy -> resource_arn:Types.resource_arn -> unit -> Types.put_resource_policy_output
val make_put_resource_policy_input : policy:Types.resource_policy -> resource_arn:Types.resource_arn -> unit -> Types.put_resource_policy_input
val make_list_tags_for_resource_output : ?next_token:Types.next_token -> tags:Types.tags -> unit -> Types.list_tags_for_resource_output
val make_list_tags_for_resource_input : ?max_results:Types.max_results -> ?next_token:Types.next_token -> resource_arn:Types.resource_arn -> unit -> Types.list_tags_for_resource_input
val make_import_key_output : key:Types.key -> unit -> Types.import_key_output
val make_import_tr31_key_block : wrapped_key_block:Types.tr31_wrapped_key_block -> wrapping_key_identifier:Types.key_arn_or_key_alias_type -> unit -> Types.import_tr31_key_block
val make_import_tr34_key_block : ?random_nonce:Types.even_hex_length_between16_and32 -> ?wrapping_key_certificate:Types.certificate_type -> ?wrapping_key_identifier:Types.key_arn_or_key_alias_type -> ?import_token:Types.import_token_id -> key_block_format:Types.tr34_key_block_format -> wrapped_key_block:Types.tr34_wrapped_key_block -> signing_key_certificate:Types.certificate_type -> certificate_authority_public_key_identifier:Types.key_arn_or_key_alias_type -> unit -> Types.import_tr34_key_block
val make_import_key_cryptogram : ?wrapping_spec:Types.wrapping_key_spec -> import_token:Types.import_token_id -> wrapped_key_cryptogram:Types.wrapped_key_cryptogram -> exportable:Smaws_Lib.Smithy_api.Types.boolean_ -> key_attributes:Types.key_attributes -> unit -> Types.import_key_cryptogram
val make_import_diffie_hellman_tr31_key_block : wrapped_key_block:Types.tr31_wrapped_key_block -> derivation_data:Types.diffie_hellman_derivation_data -> key_derivation_hash_algorithm:Types.key_derivation_hash_algorithm -> key_derivation_function:Types.key_derivation_function -> derive_key_algorithm:Types.symmetric_key_algorithm -> public_key_certificate:Types.certificate_type -> certificate_authority_public_key_identifier:Types.key_arn_or_key_alias_type -> private_key_identifier:Types.key_arn_or_key_alias_type -> unit -> Types.import_diffie_hellman_tr31_key_block
val make_import_as2805_key_cryptogram : wrapped_key_cryptogram:Types.wrapped_key_cryptogram -> wrapping_key_identifier:Types.key_arn_or_key_alias_type -> exportable:Smaws_Lib.Smithy_api.Types.boolean_ -> key_algorithm:Types.key_algorithm -> key_modes_of_use:Types.key_modes_of_use -> as2805_key_variant:Types.as2805_key_variant -> unit -> Types.import_as2805_key_cryptogram
val make_import_key_input : ?requester_comment:Types.mpa_requester_comment -> ?replication_regions:Types.regions -> ?tags:Types.tags -> ?enabled:Smaws_Lib.Smithy_api.Types.boolean_ -> ?key_check_value_algorithm:Types.key_check_value_algorithm -> key_material:Types.import_key_material -> unit -> Types.import_key_input
val make_get_resource_policy_output : policy:Types.resource_policy -> resource_arn:Types.resource_arn -> unit -> Types.get_resource_policy_output
val make_get_resource_policy_input : resource_arn:Types.resource_arn -> unit -> Types.get_resource_policy_input
val make_get_public_key_certificate_output : key_certificate_chain:Types.certificate_type -> key_certificate:Types.certificate_type -> unit -> Types.get_public_key_certificate_output
val make_get_public_key_certificate_input : key_identifier:Types.key_arn_or_key_alias_type -> unit -> Types.get_public_key_certificate_input
val make_get_parameters_for_import_output : parameters_valid_until_timestamp:Types.timestamp -> import_token:Types.import_token_id -> wrapping_key_algorithm:Types.key_algorithm -> wrapping_key_certificate_chain:Types.certificate_type -> wrapping_key_certificate:Types.certificate_type -> unit -> Types.get_parameters_for_import_output
val make_get_parameters_for_import_input : ?reuse_last_generated_token:Smaws_Lib.Smithy_api.Types.boolean_ -> wrapping_key_algorithm:Types.key_algorithm -> key_material_type:Types.key_material_type -> unit -> Types.get_parameters_for_import_input
val make_get_parameters_for_export_output : parameters_valid_until_timestamp:Types.timestamp -> export_token:Types.export_token_id -> signing_key_algorithm:Types.key_algorithm -> signing_key_certificate_chain:Types.certificate_type -> signing_key_certificate:Types.certificate_type -> unit -> Types.get_parameters_for_export_output
val make_get_parameters_for_export_input : ?reuse_last_generated_token:Smaws_Lib.Smithy_api.Types.boolean_ -> signing_key_algorithm:Types.key_algorithm -> key_material_type:Types.key_material_type -> unit -> Types.get_parameters_for_export_input
val make_mpa_team_association : ?mpa_status:Types.mpa_status -> association_state:Types.association_state -> mpa_team_arn:Types.mpa_team_arn -> action:Types.mpa_operation -> unit -> Types.mpa_team_association
val make_get_mpa_team_association_output : mpa_team_association:Types.mpa_team_association -> unit -> Types.get_mpa_team_association_output
val make_get_mpa_team_association_input : action:Types.mpa_operation -> unit -> Types.get_mpa_team_association_input
val make_get_default_key_replication_regions_output : enabled_replication_regions:Types.regions -> unit -> Types.get_default_key_replication_regions_output
val make_get_default_key_replication_regions_input : unit -> unit
val make_get_certificate_signing_request_output : certificate_signing_request:Types.certificate_signing_request_type -> unit -> Types.get_certificate_signing_request_output
val make_get_certificate_signing_request_input : certificate_subject:Types.certificate_subject_type -> signing_algorithm:Types.signing_algorithm_type -> key_identifier:Types.key_arn_or_key_alias_type -> unit -> Types.get_certificate_signing_request_input
val make_export_key_output : ?wrapped_key:Types.wrapped_key -> unit -> Types.export_key_output
val make_key_block_headers : ?optional_blocks:Types.optional_blocks -> ?key_version:Types.key_version -> ?key_exportability:Types.key_exportability -> ?key_modes_of_use:Types.key_modes_of_use -> unit -> Types.key_block_headers
val make_export_tr31_key_block : ?key_block_headers:Types.key_block_headers -> wrapping_key_identifier:Types.key_arn_or_key_alias_type -> unit -> Types.export_tr31_key_block
val make_export_tr34_key_block : ?key_block_headers:Types.key_block_headers -> ?random_nonce:Types.even_hex_length_between16_and32 -> ?signing_key_certificate:Types.certificate_type -> ?signing_key_identifier:Types.key_arn_or_key_alias_type -> ?export_token:Types.export_token_id -> key_block_format:Types.tr34_key_block_format -> wrapping_key_certificate:Types.certificate_type -> certificate_authority_public_key_identifier:Types.key_arn_or_key_alias_type -> unit -> Types.export_tr34_key_block
val make_export_key_cryptogram : ?wrapping_spec:Types.wrapping_key_spec -> wrapping_key_certificate:Types.certificate_type -> certificate_authority_public_key_identifier:Types.key_arn_or_key_alias_type -> unit -> Types.export_key_cryptogram
val make_export_diffie_hellman_tr31_key_block : ?key_block_headers:Types.key_block_headers -> derivation_data:Types.diffie_hellman_derivation_data -> key_derivation_hash_algorithm:Types.key_derivation_hash_algorithm -> key_derivation_function:Types.key_derivation_function -> derive_key_algorithm:Types.symmetric_key_algorithm -> public_key_certificate:Types.certificate_type -> certificate_authority_public_key_identifier:Types.key_arn_or_key_alias_type -> private_key_identifier:Types.key_arn_or_key_alias_type -> unit -> Types.export_diffie_hellman_tr31_key_block
val make_export_as2805_key_cryptogram : as2805_key_variant:Types.as2805_key_variant -> wrapping_key_identifier:Types.key_arn_or_key_alias_type -> unit -> Types.export_as2805_key_cryptogram
val make_export_dukpt_initial_key : key_serial_number:Types.hex_length20_or24 -> unit -> Types.export_dukpt_initial_key
val make_export_attributes : ?key_check_value_algorithm:Types.key_check_value_algorithm -> ?export_dukpt_initial_key:Types.export_dukpt_initial_key -> unit -> Types.export_attributes
val make_export_key_input : ?export_attributes:Types.export_attributes -> export_key_identifier:Types.key_arn_or_key_alias_type -> key_material:Types.export_key_material -> unit -> Types.export_key_input
val make_enable_default_key_replication_regions_output : enabled_replication_regions:Types.regions -> unit -> Types.enable_default_key_replication_regions_output
val make_enable_default_key_replication_regions_input : replication_regions:Types.regions -> unit -> Types.enable_default_key_replication_regions_input
val make_disassociate_mpa_team_output : mpa_team_association:Types.mpa_team_association -> unit -> Types.disassociate_mpa_team_output
val make_disassociate_mpa_team_input : ?requester_comment:Types.mpa_requester_comment -> action:Types.mpa_operation -> unit -> Types.disassociate_mpa_team_input
val make_disable_default_key_replication_regions_output : enabled_replication_regions:Types.regions -> unit -> Types.disable_default_key_replication_regions_output
val make_disable_default_key_replication_regions_input : replication_regions:Types.regions -> unit -> Types.disable_default_key_replication_regions_input
val make_delete_resource_policy_output : unit -> unit
val make_delete_resource_policy_input : resource_arn:Types.resource_arn -> unit -> Types.delete_resource_policy_input
val make_associate_mpa_team_output : mpa_team_association:Types.mpa_team_association -> unit -> Types.associate_mpa_team_output
val make_associate_mpa_team_input : ?requester_comment:Types.mpa_requester_comment -> mpa_team_arn:Types.mpa_team_arn -> action:Types.mpa_operation -> unit -> Types.associate_mpa_team_input
val make_key_summary : ?primary_region:Types.region -> ?multi_region_key_type:Types.multi_region_key_type -> enabled:Smaws_Lib.Smithy_api.Types.boolean_ -> exportable:Smaws_Lib.Smithy_api.Types.boolean_ -> key_check_value:Types.key_check_value -> key_attributes:Types.key_attributes -> key_state:Types.key_state -> key_arn:Types.key_arn -> unit -> Types.key_summary
val make_list_keys_output : ?next_token:Types.next_token -> keys:Types.key_summary_list -> unit -> Types.list_keys_output
val make_list_keys_input : ?max_results:Types.max_results -> ?next_token:Types.next_token -> ?key_state:Types.key_state -> unit -> Types.list_keys_input
val make_list_aliases_output : ?next_token:Types.next_token -> aliases:Types.aliases -> unit -> Types.list_aliases_output
val make_list_aliases_input : ?max_results:Types.max_results -> ?next_token:Types.next_token -> ?key_arn:Types.key_arn -> unit -> Types.list_aliases_input
val make_get_key_output : key:Types.key -> unit -> Types.get_key_output
val make_get_key_input : key_identifier:Types.key_arn_or_key_alias_type -> unit -> Types.get_key_input
val make_get_alias_output : alias:Types.alias -> unit -> Types.get_alias_output
val make_get_alias_input : alias_name:Types.alias_name -> unit -> Types.get_alias_input
val make_delete_key_output : key:Types.key -> unit -> Types.delete_key_output
val make_delete_key_input : ?delete_key_in_days:Smaws_Lib.Smithy_api.Types.integer -> key_identifier:Types.key_arn_or_key_alias_type -> unit -> Types.delete_key_input
val make_delete_alias_output : unit -> unit
val make_delete_alias_input : alias_name:Types.alias_name -> unit -> Types.delete_alias_input
val make_create_key_output : key:Types.key -> unit -> Types.create_key_output
val make_create_key_input : ?replication_regions:Types.regions -> ?derive_key_usage:Types.derive_key_usage -> ?tags:Types.tags -> ?enabled:Smaws_Lib.Smithy_api.Types.boolean_ -> ?key_check_value_algorithm:Types.key_check_value_algorithm -> exportable:Smaws_Lib.Smithy_api.Types.boolean_ -> key_attributes:Types.key_attributes -> unit -> Types.create_key_input
val make_create_alias_output : alias:Types.alias -> unit -> Types.create_alias_output
val make_create_alias_input : ?key_arn:Types.key_arn -> alias_name:Types.alias_name -> unit -> Types.create_alias_input
val make_add_key_replication_regions_output : key:Types.key -> unit -> Types.add_key_replication_regions_output
val make_add_key_replication_regions_input : replication_regions:Types.regions -> key_identifier:Types.key_arn_or_key_alias_type -> unit -> Types.add_key_replication_regions_input

Operations

module AddKeyReplicationRegions : sig ... end

Adds replication Amazon Web Services Regions to an existing Amazon Web Services Payment Cryptography key, enabling the key to be used for cryptographic operations in additional Amazon Web Services Regions.

module CreateAlias : sig ... end

Creates an alias, or a friendly name, for an Amazon Web Services Payment Cryptography key. You can use an alias to identify a key in the console and when you call cryptographic operations such as EncryptData or DecryptData.

module CreateKey : sig ... end

Creates an Amazon Web Services Payment Cryptography key, a logical representation of a cryptographic key, that is unique in your account and Amazon Web Services Region. You use keys for cryptographic functions such as encryption and decryption.

module DeleteAlias : sig ... end

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

module DeleteKey : sig ... end

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

module GetAlias : sig ... end

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

module GetKey : sig ... end

Gets the key metadata for an Amazon Web Services Payment Cryptography key, including the immutable and mutable attributes specified when the key was created. Returns key metadata including attributes, state, and timestamps, but does not return the actual cryptographic key material.

module ListAliases : sig ... end

Lists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the aliases by keyARN. For more information, see Using aliases in the Amazon Web Services Payment Cryptography User Guide.

module ListKeys : sig ... end

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

module AssociateMpaTeam : sig ... end

Associates a Multi-Party Approval (MPA) team with a protected operation. For more information, see Multi-Party Approval in the Amazon Web Services Payment Cryptography User Guide.

module DeleteResourcePolicy : sig ... end

Removes the resource-based policy attached to an Amazon Web Services Payment Cryptography key.

Disables Multi-Region key replication settings for the specified Amazon Web Services Regions in your Amazon Web Services account, preventing new keys from being automatically replicated to those regions.

module DisassociateMpaTeam : sig ... end

Removes the association between a Multi-Party Approval (MPA) team and a protected operation.

Enables Multi-Region key replication settings for your Amazon Web Services account, causing new keys to be automatically replicated to the specified Amazon Web Services Regions when created.

module ExportKey : sig ... end

Exports a key from Amazon Web Services Payment Cryptography.

module GetCertificateSigningRequest : sig ... end

Creates a certificate signing request (CSR) from a key pair.

module GetDefaultKeyReplicationRegions : sig ... end

Retrieves the list of Amazon Web Services Regions where Multi-Region key replication is currently enabled for your Amazon Web Services account.

module GetMpaTeamAssociation : sig ... end

Returns the Multi-Party Approval (MPA) team association for a protected operation.

module GetParametersForExport : sig ... end

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

module GetParametersForImport : sig ... end

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

module GetPublicKeyCertificate : sig ... end

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

module GetResourcePolicy : sig ... end

Returns the resource-based policy attached to an Amazon Web Services Payment Cryptography key.

module ImportKey : sig ... end

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

module ListTagsForResource : sig ... end

Lists the tags for an Amazon Web Services resource.

module PutResourcePolicy : sig ... end

Attaches or replaces a resource-based policy on an Amazon Web Services Payment Cryptography key. A resource-based policy can grant cross-account access to your key.

module RemoveKeyReplicationRegions : sig ... end

Removes Replication Regions from an existing Amazon Web Services Payment Cryptography key, disabling the key's availability for cryptographic operations in the specified Amazon Web Services Regions.

module RestoreKey : sig ... end

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

module StartKeyUsage : sig ... end

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

module StopKeyUsage : sig ... end

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

module TagResource : sig ... end

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

module UntagResource : sig ... end

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

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