Module Smaws_Client_ACM

ACM client library built on EIO.

Types

module Types : sig ... end

Builders

val make_certificate_options : ?export_:Types.certificate_export -> ?certificate_transparency_logging_preference: Types.certificate_transparency_logging_preference -> unit -> Types.certificate_options
val make_update_certificate_options_request : options:Types.certificate_options -> certificate_arn:Types.arn -> unit -> Types.update_certificate_options_request
val make_tag : ?value:Types.tag_value -> key:Types.tag_key -> unit -> Types.tag
val make_revoke_certificate_response : ?certificate_arn:Types.arn -> unit -> Types.revoke_certificate_response
val make_revoke_certificate_request : revocation_reason:Types.revocation_reason -> certificate_arn:Types.arn -> unit -> Types.revoke_certificate_request
val make_resource_record : value:Types.string_ -> type_:Types.record_type -> name:Types.string_ -> unit -> Types.resource_record
val make_resend_validation_email_request : validation_domain:Types.domain_name_string -> domain:Types.domain_name_string -> certificate_arn:Types.arn -> unit -> Types.resend_validation_email_request
val make_request_certificate_response : ?certificate_arn:Types.arn -> unit -> Types.request_certificate_response
val make_domain_validation_option : validation_domain:Types.domain_name_string -> domain_name:Types.domain_name_string -> unit -> Types.domain_validation_option
val make_request_certificate_request : ?managed_by:Types.certificate_managed_by -> ?key_algorithm:Types.key_algorithm -> ?tags:Types.tag_list -> ?certificate_authority_arn:Types.pca_arn -> ?options:Types.certificate_options -> ?domain_validation_options:Types.domain_validation_option_list -> ?idempotency_token:Types.idempotency_token -> ?subject_alternative_names:Types.domain_list -> ?validation_method:Types.validation_method -> domain_name:Types.domain_name_string -> unit -> Types.request_certificate_request
val make_http_redirect : ?redirect_to:Types.string_ -> ?redirect_from:Types.string_ -> unit -> Types.http_redirect
val make_domain_validation : ?validation_method:Types.validation_method -> ?http_redirect:Types.http_redirect -> ?resource_record:Types.resource_record -> ?validation_status:Types.domain_status -> ?validation_domain:Types.domain_name_string -> ?validation_emails:Types.validation_email_list -> domain_name:Types.domain_name_string -> unit -> Types.domain_validation
val make_renewal_summary : ?renewal_status_reason:Types.failure_reason -> updated_at:Types.t_stamp -> domain_validation_options:Types.domain_validation_list -> renewal_status:Types.renewal_status -> unit -> Types.renewal_summary
val make_renew_certificate_request : certificate_arn:Types.arn -> unit -> Types.renew_certificate_request
val make_remove_tags_from_certificate_request : tags:Types.tag_list -> certificate_arn:Types.arn -> unit -> Types.remove_tags_from_certificate_request
val make_expiry_events_configuration : ?days_before_expiry:Types.positive_integer -> unit -> Types.expiry_events_configuration
val make_put_account_configuration_request : ?expiry_events:Types.expiry_events_configuration -> idempotency_token:Types.idempotency_token -> unit -> Types.put_account_configuration_request
val make_list_tags_for_certificate_response : ?tags:Types.tag_list -> unit -> Types.list_tags_for_certificate_response
val make_list_tags_for_certificate_request : certificate_arn:Types.arn -> unit -> Types.list_tags_for_certificate_request
val make_certificate_summary : ?managed_by:Types.certificate_managed_by -> ?revoked_at:Types.t_stamp -> ?imported_at:Types.t_stamp -> ?issued_at:Types.t_stamp -> ?created_at:Types.t_stamp -> ?not_after:Types.t_stamp -> ?not_before:Types.t_stamp -> ?renewal_eligibility:Types.renewal_eligibility -> ?exported:Types.nullable_boolean -> ?in_use:Types.nullable_boolean -> ?export_option:Types.certificate_export -> ?extended_key_usages:Types.extended_key_usage_names -> ?key_usages:Types.key_usage_names -> ?key_algorithm:Types.key_algorithm -> ?type_:Types.certificate_type -> ?status:Types.certificate_status -> ?has_additional_subject_alternative_names:Types.nullable_boolean -> ?subject_alternative_name_summaries:Types.domain_list -> ?domain_name:Types.domain_name_string -> ?certificate_arn:Types.arn -> unit -> Types.certificate_summary
val make_list_certificates_response : ?certificate_summary_list:Types.certificate_summary_list -> ?next_token:Types.next_token -> unit -> Types.list_certificates_response
val make_filters : ?managed_by:Types.certificate_managed_by -> ?export_option:Types.certificate_export -> ?key_types:Types.key_algorithm_list -> ?key_usage:Types.key_usage_filter_list -> ?extended_key_usage:Types.extended_key_usage_filter_list -> unit -> Types.filters
val make_list_certificates_request : ?sort_order:Types.sort_order -> ?sort_by:Types.sort_by -> ?max_items:Types.max_items -> ?next_token:Types.next_token -> ?includes:Types.filters -> ?certificate_statuses:Types.certificate_statuses -> unit -> Types.list_certificates_request
val make_key_usage : ?name:Types.key_usage_name -> unit -> Types.key_usage
val make_import_certificate_response : ?certificate_arn:Types.arn -> unit -> Types.import_certificate_response
val make_import_certificate_request : ?tags:Types.tag_list -> ?certificate_chain:Types.certificate_chain_blob -> ?certificate_arn:Types.arn -> private_key:Types.private_key_blob -> certificate:Types.certificate_body_blob -> unit -> Types.import_certificate_request
val make_get_certificate_response : ?certificate_chain:Types.certificate_chain -> ?certificate:Types.certificate_body -> unit -> Types.get_certificate_response
val make_get_certificate_request : certificate_arn:Types.arn -> unit -> Types.get_certificate_request
val make_get_account_configuration_response : ?expiry_events:Types.expiry_events_configuration -> unit -> Types.get_account_configuration_response
val make_extended_key_usage : ?oi_d:Types.string_ -> ?name:Types.extended_key_usage_name -> unit -> Types.extended_key_usage
val make_export_certificate_response : ?private_key:Types.private_key -> ?certificate_chain:Types.certificate_chain -> ?certificate:Types.certificate_body -> unit -> Types.export_certificate_response
val make_export_certificate_request : passphrase:Types.passphrase_blob -> certificate_arn:Types.arn -> unit -> Types.export_certificate_request
val make_certificate_detail : ?options:Types.certificate_options -> ?renewal_eligibility:Types.renewal_eligibility -> ?certificate_authority_arn:Types.arn -> ?extended_key_usages:Types.extended_key_usage_list -> ?key_usages:Types.key_usage_list -> ?renewal_summary:Types.renewal_summary -> ?type_:Types.certificate_type -> ?failure_reason:Types.failure_reason -> ?in_use_by:Types.in_use_list -> ?signature_algorithm:Types.string_ -> ?key_algorithm:Types.key_algorithm -> ?not_after:Types.t_stamp -> ?not_before:Types.t_stamp -> ?revocation_reason:Types.revocation_reason -> ?revoked_at:Types.t_stamp -> ?status:Types.certificate_status -> ?imported_at:Types.t_stamp -> ?issued_at:Types.t_stamp -> ?created_at:Types.t_stamp -> ?issuer:Types.string_ -> ?subject:Types.string_ -> ?serial:Types.string_ -> ?domain_validation_options:Types.domain_validation_list -> ?managed_by:Types.certificate_managed_by -> ?subject_alternative_names:Types.domain_list -> ?domain_name:Types.domain_name_string -> ?certificate_arn:Types.arn -> unit -> Types.certificate_detail
val make_describe_certificate_response : ?certificate:Types.certificate_detail -> unit -> Types.describe_certificate_response
val make_describe_certificate_request : certificate_arn:Types.arn -> unit -> Types.describe_certificate_request
val make_delete_certificate_request : certificate_arn:Types.arn -> unit -> Types.delete_certificate_request
val make_add_tags_to_certificate_request : tags:Types.tag_list -> certificate_arn:Types.arn -> unit -> Types.add_tags_to_certificate_request

Operations

module AddTagsToCertificate : sig ... end

Adds one or more tags to an ACM certificate. Tags are labels that you can use to identify and organize your Amazon Web Services resources. Each tag consists of a key and an optional value. You specify the certificate on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair.

module DeleteCertificate : sig ... end

Deletes a certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list that can be displayed by calling the ListCertificates action or be retrieved by calling the GetCertificate action. The certificate will not be available for use by Amazon Web Services services integrated with ACM.

module DescribeCertificate : sig ... end

Returns detailed metadata about the specified ACM certificate.

module ExportCertificate : sig ... end

Exports a private certificate issued by a private certificate authority (CA) or public certificate for use anywhere. The exported file contains the certificate, the certificate chain, and the encrypted private key associated with the public key that is embedded in the certificate. For security, you must assign a passphrase for the private key when exporting it.

module GetAccountConfiguration : sig ... end

Returns the account configuration options associated with an Amazon Web Services account.

module GetCertificate : sig ... end

Retrieves a certificate and its certificate chain. The certificate may be either a public or private certificate issued using the ACM RequestCertificate action, or a certificate imported into ACM using the ImportCertificate action. The chain consists of the certificate of the issuing CA and the intermediate certificates of any other subordinate CAs. All of the certificates are base64 encoded. You can use OpenSSL to decode the certificates and inspect individual fields.

module ImportCertificate : sig ... end

Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with ACM. Note that integrated services allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see Importing Certificates in the Certificate Manager User Guide.

module ListCertificates : sig ... end

Retrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate. Default filtering returns only RSA_2048 certificates. For more information, see Filters.

module ListTagsForCertificate : sig ... end

Lists the tags that have been applied to the ACM certificate. Use the certificate's Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM certificate, use the AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate action.

module PutAccountConfiguration : sig ... end

Adds or modifies account-level configurations in ACM.

module RemoveTagsFromCertificate : sig ... end

Remove one or more tags from an ACM certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value.

module RenewCertificate : sig ... end

Renews an eligible ACM certificate. In order to renew your Amazon Web Services Private CA certificates with ACM, you must first grant the ACM service principal permission to do so. For more information, see Testing Managed Renewal in the ACM User Guide.

module RequestCertificate : sig ... end

Requests an ACM certificate for use with other Amazon Web Services services. To request an ACM certificate, you must specify a fully qualified domain name (FQDN) in the DomainName parameter. You can also specify additional FQDNs in the SubjectAlternativeNames parameter.

module ResendValidationEmail : sig ... end

Resends the email that requests domain ownership validation. The domain owner or an authorized representative must approve the ACM certificate before it can be issued. The certificate can be approved by clicking a link in the mail to navigate to the Amazon certificate approval website and then clicking I Approve. However, the validation email can be blocked by spam filters. Therefore, if you do not receive the original mail, you can request that the mail be resent within 72 hours of requesting the ACM certificate. If more than 72 hours have elapsed since your original request or since your last attempt to resend validation mail, you must request a new certificate. For more information about setting up your contact email addresses, see Configure Email for your Domain.

module RevokeCertificate : sig ... end

Revokes a public ACM certificate. You can only revoke certificates that have been previously exported.

module UpdateCertificateOptions : sig ... end

Updates a certificate. You can use this function to specify whether to opt in to or out of recording your certificate in a certificate transparency log and exporting. For more information, see Opting Out of Certificate Transparency Logging and Certificate Manager Exportable Managed Certificates.

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