package smaws-clients

  1. Overview
  2. Docs
package smaws-clients
Legend:
Library
Module
Module type
Parameter
Class
Class type
type validation_method =
  1. | DNS
  2. | EMAIL
type validation_exception = {
  1. message : string option;
}
type certificate_transparency_logging_preference =
  1. | DISABLED
  2. | ENABLED
type certificate_options = {
  1. certificate_transparency_logging_preference : certificate_transparency_logging_preference option;
}
type update_certificate_options_request = {
  1. options : certificate_options;
  2. certificate_arn : string;
}
type resource_not_found_exception = {
  1. message : string option;
}
type limit_exceeded_exception = {
  1. message : string option;
}
type invalid_state_exception = {
  1. message : string option;
}
type invalid_arn_exception = {
  1. message : string option;
}
type too_many_tags_exception = {
  1. message : string option;
}
type throttling_exception = {
  1. message : string option;
}
type tag_policy_exception = {
  1. message : string option;
}
type tag = {
  1. value : string option;
  2. key : string;
}
type sort_order =
  1. | DESCENDING
  2. | ASCENDING
type sort_by =
  1. | CREATED_AT
type revocation_reason =
  1. | A_A_COMPROMISE
  2. | PRIVILEGE_WITHDRAWN
  3. | REMOVE_FROM_CRL
  4. | CERTIFICATE_HOLD
  5. | CESSATION_OF_OPERATION
  6. | SUPERCEDED
  7. | AFFILIATION_CHANGED
  8. | CA_COMPROMISE
  9. | KEY_COMPROMISE
  10. | UNSPECIFIED
type record_type =
  1. | CNAME
type resource_record = {
  1. value : string;
  2. type_ : record_type;
  3. name : string;
}
type resource_in_use_exception = {
  1. message : string option;
}
type resend_validation_email_request = {
  1. validation_domain : string;
  2. domain : string;
  3. certificate_arn : string;
}
type invalid_domain_validation_options_exception = {
  1. message : string option;
}
type request_in_progress_exception = {
  1. message : string option;
}
type request_certificate_response = {
  1. certificate_arn : string option;
}
type domain_validation_option = {
  1. validation_domain : string;
  2. domain_name : string;
}
type key_algorithm =
  1. | EC_secp521r1
  2. | EC_secp384r1
  3. | EC_prime256v1
  4. | RSA_4096
  5. | RSA_3072
  6. | RSA_2048
  7. | RSA_1024
type request_certificate_request = {
  1. key_algorithm : key_algorithm option;
  2. tags : tag list option;
  3. certificate_authority_arn : string option;
  4. options : certificate_options option;
  5. domain_validation_options : domain_validation_option list option;
  6. idempotency_token : string option;
  7. subject_alternative_names : string list option;
  8. validation_method : validation_method option;
  9. domain_name : string;
}
type invalid_tag_exception = {
  1. message : string option;
}
type invalid_parameter_exception = {
  1. message : string option;
}
type renewal_status =
  1. | FAILED
  2. | SUCCESS
  3. | PENDING_VALIDATION
  4. | PENDING_AUTO_RENEWAL
type domain_status =
  1. | FAILED
  2. | SUCCESS
  3. | PENDING_VALIDATION
type domain_validation = {
  1. validation_method : validation_method option;
  2. resource_record : resource_record option;
  3. validation_status : domain_status option;
  4. validation_domain : string option;
  5. validation_emails : string list option;
  6. domain_name : string;
}
type failure_reason =
  1. | OTHER
  2. | SLR_NOT_FOUND
  3. | PCA_ACCESS_DENIED
  4. | PCA_INVALID_DURATION
  5. | PCA_INVALID_ARGS
  6. | PCA_RESOURCE_NOT_FOUND
  7. | PCA_NAME_CONSTRAINTS_VALIDATION
  8. | PCA_REQUEST_FAILED
  9. | PCA_INVALID_STATE
  10. | PCA_INVALID_ARN
  11. | PCA_LIMIT_EXCEEDED
  12. | CAA_ERROR
  13. | DOMAIN_VALIDATION_DENIED
  14. | INVALID_PUBLIC_DOMAIN
  15. | DOMAIN_NOT_ALLOWED
  16. | ADDITIONAL_VERIFICATION_REQUIRED
  17. | NO_AVAILABLE_CONTACTS
type renewal_summary = {
  1. updated_at : float;
  2. renewal_status_reason : failure_reason option;
  3. domain_validation_options : domain_validation list;
  4. renewal_status : renewal_status;
}
type renewal_eligibility =
  1. | INELIGIBLE
  2. | ELIGIBLE
type renew_certificate_request = {
  1. certificate_arn : string;
}
type remove_tags_from_certificate_request = {
  1. tags : tag list;
  2. certificate_arn : string;
}
type expiry_events_configuration = {
  1. days_before_expiry : int option;
}
type put_account_configuration_request = {
  1. idempotency_token : string;
  2. expiry_events : expiry_events_configuration option;
}
type conflict_exception = {
  1. message : string option;
}
type access_denied_exception = {
  1. message : string option;
}
type list_tags_for_certificate_response = {
  1. tags : tag list option;
}
type list_tags_for_certificate_request = {
  1. certificate_arn : string;
}
type certificate_status =
  1. | FAILED
  2. | REVOKED
  3. | VALIDATION_TIMED_OUT
  4. | EXPIRED
  5. | INACTIVE
  6. | ISSUED
  7. | PENDING_VALIDATION
type certificate_type =
  1. | PRIVATE
  2. | AMAZON_ISSUED
  3. | IMPORTED
type key_usage_name =
  1. | CUSTOM
  2. | ANY
  3. | DECIPHER_ONLY
  4. | ENCHIPER_ONLY
  5. | CRL_SIGNING
  6. | CERTIFICATE_SIGNING
  7. | KEY_AGREEMENT
  8. | DATA_ENCIPHERMENT
  9. | KEY_ENCIPHERMENT
  10. | NON_REPUDATION
  11. | DIGITAL_SIGNATURE
type extended_key_usage_name =
  1. | CUSTOM
  2. | NONE
  3. | ANY
  4. | IPSEC_USER
  5. | IPSEC_TUNNEL
  6. | IPSEC_END_SYSTEM
  7. | OCSP_SIGNING
  8. | TIME_STAMPING
  9. | EMAIL_PROTECTION
  10. | CODE_SIGNING
  11. | TLS_WEB_CLIENT_AUTHENTICATION
  12. | TLS_WEB_SERVER_AUTHENTICATION
type certificate_summary = {
  1. revoked_at : float option;
  2. imported_at : float option;
  3. issued_at : float option;
  4. created_at : float option;
  5. not_after : float option;
  6. not_before : float option;
  7. renewal_eligibility : renewal_eligibility option;
  8. exported : bool option;
  9. in_use : bool option;
  10. extended_key_usages : extended_key_usage_name list option;
  11. key_usages : key_usage_name list option;
  12. key_algorithm : key_algorithm option;
  13. type_ : certificate_type option;
  14. status : certificate_status option;
  15. has_additional_subject_alternative_names : bool option;
  16. subject_alternative_name_summaries : string list option;
  17. domain_name : string option;
  18. certificate_arn : string option;
}
type list_certificates_response = {
  1. certificate_summary_list : certificate_summary list option;
  2. next_token : string option;
}
type filters = {
  1. key_types : key_algorithm list option;
  2. key_usage : key_usage_name list option;
  3. extended_key_usage : extended_key_usage_name list option;
}
type list_certificates_request = {
  1. sort_order : sort_order option;
  2. sort_by : sort_by option;
  3. max_items : int option;
  4. next_token : string option;
  5. includes : filters option;
  6. certificate_statuses : certificate_status list option;
}
type invalid_args_exception = {
  1. message : string option;
}
type key_usage = {
  1. name : key_usage_name option;
}
type import_certificate_response = {
  1. certificate_arn : string option;
}
type import_certificate_request = {
  1. tags : tag list option;
  2. certificate_chain : bytes option;
  3. private_key : bytes;
  4. certificate : bytes;
  5. certificate_arn : string option;
}
type get_certificate_response = {
  1. certificate_chain : string option;
  2. certificate : string option;
}
type get_certificate_request = {
  1. certificate_arn : string;
}
type get_account_configuration_response = {
  1. expiry_events : expiry_events_configuration option;
}
type extended_key_usage = {
  1. oi_d : string option;
  2. name : extended_key_usage_name option;
}
type export_certificate_response = {
  1. private_key : string option;
  2. certificate_chain : string option;
  3. certificate : string option;
}
type export_certificate_request = {
  1. passphrase : bytes;
  2. certificate_arn : string;
}
type certificate_detail = {
  1. options : certificate_options option;
  2. renewal_eligibility : renewal_eligibility option;
  3. certificate_authority_arn : string option;
  4. extended_key_usages : extended_key_usage list option;
  5. key_usages : key_usage list option;
  6. renewal_summary : renewal_summary option;
  7. type_ : certificate_type option;
  8. failure_reason : failure_reason option;
  9. in_use_by : string list option;
  10. signature_algorithm : string option;
  11. key_algorithm : key_algorithm option;
  12. not_after : float option;
  13. not_before : float option;
  14. revocation_reason : revocation_reason option;
  15. revoked_at : float option;
  16. status : certificate_status option;
  17. imported_at : float option;
  18. issued_at : float option;
  19. created_at : float option;
  20. issuer : string option;
  21. subject : string option;
  22. serial : string option;
  23. domain_validation_options : domain_validation list option;
  24. subject_alternative_names : string list option;
  25. domain_name : string option;
  26. certificate_arn : string option;
}
type describe_certificate_response = {
  1. certificate : certificate_detail option;
}
type describe_certificate_request = {
  1. certificate_arn : string;
}
type delete_certificate_request = {
  1. certificate_arn : string;
}
type add_tags_to_certificate_request = {
  1. tags : tag list;
  2. certificate_arn : string;
}
type base_document = Smaws_Lib.Json.t
val make_certificate_options : ?certificate_transparency_logging_preference: certificate_transparency_logging_preference -> unit -> certificate_options
val make_update_certificate_options_request : options:certificate_options -> certificate_arn:string -> unit -> update_certificate_options_request
val make_tag : ?value:string -> key:string -> unit -> tag
val make_resource_record : value:string -> type_:record_type -> name:string -> unit -> resource_record
val make_resend_validation_email_request : validation_domain:string -> domain:string -> certificate_arn:string -> unit -> resend_validation_email_request
val make_request_certificate_response : ?certificate_arn:string -> unit -> request_certificate_response
val make_domain_validation_option : validation_domain:string -> domain_name:string -> unit -> domain_validation_option
val make_request_certificate_request : ?key_algorithm:key_algorithm -> ?tags:tag list -> ?certificate_authority_arn:string -> ?options:certificate_options -> ?domain_validation_options:domain_validation_option list -> ?idempotency_token:string -> ?subject_alternative_names:string list -> ?validation_method:validation_method -> domain_name:string -> unit -> request_certificate_request
val make_domain_validation : ?validation_method:validation_method -> ?resource_record:resource_record -> ?validation_status:domain_status -> ?validation_domain:string -> ?validation_emails:string list -> domain_name:string -> unit -> domain_validation
val make_renewal_summary : ?renewal_status_reason:failure_reason -> updated_at:float -> domain_validation_options:domain_validation list -> renewal_status:renewal_status -> unit -> renewal_summary
val make_renew_certificate_request : certificate_arn:string -> unit -> renew_certificate_request
val make_remove_tags_from_certificate_request : tags:tag list -> certificate_arn:string -> unit -> remove_tags_from_certificate_request
val make_expiry_events_configuration : ?days_before_expiry:int -> unit -> expiry_events_configuration
val make_put_account_configuration_request : ?expiry_events:expiry_events_configuration -> idempotency_token:string -> unit -> put_account_configuration_request
val make_list_tags_for_certificate_response : ?tags:tag list -> unit -> list_tags_for_certificate_response
val make_list_tags_for_certificate_request : certificate_arn:string -> unit -> list_tags_for_certificate_request
val make_certificate_summary : ?revoked_at:float -> ?imported_at:float -> ?issued_at:float -> ?created_at:float -> ?not_after:float -> ?not_before:float -> ?renewal_eligibility:renewal_eligibility -> ?exported:bool -> ?in_use:bool -> ?extended_key_usages:extended_key_usage_name list -> ?key_usages:key_usage_name list -> ?key_algorithm:key_algorithm -> ?type_:certificate_type -> ?status:certificate_status -> ?has_additional_subject_alternative_names:bool -> ?subject_alternative_name_summaries:string list -> ?domain_name:string -> ?certificate_arn:string -> unit -> certificate_summary
val make_list_certificates_response : ?certificate_summary_list:certificate_summary list -> ?next_token:string -> unit -> list_certificates_response
val make_filters : ?key_types:key_algorithm list -> ?key_usage:key_usage_name list -> ?extended_key_usage:extended_key_usage_name list -> unit -> filters
val make_list_certificates_request : ?sort_order:sort_order -> ?sort_by:sort_by -> ?max_items:int -> ?next_token:string -> ?includes:filters -> ?certificate_statuses:certificate_status list -> unit -> list_certificates_request
val make_key_usage : ?name:key_usage_name -> unit -> key_usage
val make_import_certificate_response : ?certificate_arn:string -> unit -> import_certificate_response
val make_import_certificate_request : ?tags:tag list -> ?certificate_chain:bytes -> ?certificate_arn:string -> private_key:bytes -> certificate:bytes -> unit -> import_certificate_request
val make_get_certificate_response : ?certificate_chain:string -> ?certificate:string -> unit -> get_certificate_response
val make_get_certificate_request : certificate_arn:string -> unit -> get_certificate_request
val make_get_account_configuration_response : ?expiry_events:expiry_events_configuration -> unit -> get_account_configuration_response
val make_extended_key_usage : ?oi_d:string -> ?name:extended_key_usage_name -> unit -> extended_key_usage
val make_export_certificate_response : ?private_key:string -> ?certificate_chain:string -> ?certificate:string -> unit -> export_certificate_response
val make_export_certificate_request : passphrase:bytes -> certificate_arn:string -> unit -> export_certificate_request
val make_certificate_detail : ?options:certificate_options -> ?renewal_eligibility:renewal_eligibility -> ?certificate_authority_arn:string -> ?extended_key_usages:extended_key_usage list -> ?key_usages:key_usage list -> ?renewal_summary:renewal_summary -> ?type_:certificate_type -> ?failure_reason:failure_reason -> ?in_use_by:string list -> ?signature_algorithm:string -> ?key_algorithm:key_algorithm -> ?not_after:float -> ?not_before:float -> ?revocation_reason:revocation_reason -> ?revoked_at:float -> ?status:certificate_status -> ?imported_at:float -> ?issued_at:float -> ?created_at:float -> ?issuer:string -> ?subject:string -> ?serial:string -> ?domain_validation_options:domain_validation list -> ?subject_alternative_names:string list -> ?domain_name:string -> ?certificate_arn:string -> unit -> certificate_detail
val make_describe_certificate_response : ?certificate:certificate_detail -> unit -> describe_certificate_response
val make_describe_certificate_request : certificate_arn:string -> unit -> describe_certificate_request
val make_delete_certificate_request : certificate_arn:string -> unit -> delete_certificate_request
val make_add_tags_to_certificate_request : tags:tag list -> certificate_arn:string -> unit -> add_tags_to_certificate_request
module UpdateCertificateOptions : sig ... end
module ResendValidationEmail : sig ... end
module RequestCertificate : sig ... end
module RenewCertificate : sig ... end
module RemoveTagsFromCertificate : sig ... end
module PutAccountConfiguration : sig ... end
module ListTagsForCertificate : sig ... end
module ListCertificates : sig ... end
module ImportCertificate : sig ... end
module GetCertificate : sig ... end
module GetAccountConfiguration : sig ... end
module ExportCertificate : sig ... end
module DescribeCertificate : sig ... end
module DeleteCertificate : sig ... end
module AddTagsToCertificate : 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