Module Smaws_Client_ACMPCA

ACM PCA client library built on EIO.

Types

module Types : sig ... end

Builders

val make_validity : type_:Types.validity_period_type -> value:Types.positive_long -> unit -> Types.validity
val make_crl_distribution_point_extension_configuration : omit_extension:Types.boolean_ -> unit -> Types.crl_distribution_point_extension_configuration
val make_crl_configuration : ?custom_path:Types.crl_path_string -> ?crl_type:Types.crl_type -> ?crl_distribution_point_extension_configuration: Types.crl_distribution_point_extension_configuration -> ?s3_object_acl:Types.s3_object_acl -> ?s3_bucket_name:Types.s3_bucket_name3_to255 -> ?custom_cname:Types.cname_string -> ?expiration_in_days:Types.integer1_to5000 -> enabled:Types.boolean_ -> unit -> Types.crl_configuration
val make_ocsp_configuration : ?ocsp_custom_cname:Types.cname_string -> enabled:Types.boolean_ -> unit -> Types.ocsp_configuration
val make_revocation_configuration : ?ocsp_configuration:Types.ocsp_configuration -> ?crl_configuration:Types.crl_configuration -> unit -> Types.revocation_configuration
val make_update_certificate_authority_request : ?status:Types.certificate_authority_status -> ?revocation_configuration:Types.revocation_configuration -> certificate_authority_arn:Types.arn -> unit -> Types.update_certificate_authority_request
val make_tag : ?value:Types.tag_value -> key:Types.tag_key -> unit -> Types.tag
val make_untag_certificate_authority_request : tags:Types.tag_list -> certificate_authority_arn:Types.arn -> unit -> Types.untag_certificate_authority_request
val make_tag_certificate_authority_request : tags:Types.tag_list -> certificate_authority_arn:Types.arn -> unit -> Types.tag_certificate_authority_request
val make_revoke_certificate_request : revocation_reason:Types.revocation_reason -> certificate_serial:Types.string128 -> certificate_authority_arn:Types.arn -> unit -> Types.revoke_certificate_request
val make_restore_certificate_authority_request : certificate_authority_arn:Types.arn -> unit -> Types.restore_certificate_authority_request
val make_qualifier : cps_uri:Types.string256 -> unit -> Types.qualifier
val make_put_policy_request : policy:Types.aws_policy -> resource_arn:Types.arn -> unit -> Types.put_policy_request
val make_policy_qualifier_info : qualifier:Types.qualifier -> policy_qualifier_id:Types.policy_qualifier_id -> unit -> Types.policy_qualifier_info
val make_policy_information : ?policy_qualifiers:Types.policy_qualifier_info_list -> cert_policy_id:Types.custom_object_identifier -> unit -> Types.policy_information
val make_permission : ?policy:Types.aws_policy -> ?actions:Types.action_list -> ?source_account:Types.account_id -> ?principal:Types.principal -> ?created_at:Types.t_stamp -> ?certificate_authority_arn:Types.arn -> unit -> Types.permission
val make_other_name : value:Types.string256 -> type_id:Types.custom_object_identifier -> unit -> Types.other_name
val make_list_tags_response : ?tags:Types.tag_list -> ?next_token:Types.next_token -> unit -> Types.list_tags_response
val make_list_tags_request : ?next_token:Types.next_token -> ?max_results:Types.max_results -> certificate_authority_arn:Types.arn -> unit -> Types.list_tags_request
val make_list_permissions_response : ?permissions:Types.permission_list -> ?next_token:Types.next_token -> unit -> Types.list_permissions_response
val make_list_permissions_request : ?next_token:Types.next_token -> ?max_results:Types.max_results -> certificate_authority_arn:Types.arn -> unit -> Types.list_permissions_request
val make_custom_attribute : value:Types.string1_to256 -> object_identifier:Types.custom_object_identifier -> unit -> Types.custom_attribute
val make_asn1_subject : ?custom_attributes:Types.custom_attribute_list -> ?generation_qualifier:Types.string3 -> ?pseudonym:Types.string128 -> ?initials:Types.string5 -> ?given_name:Types.string16 -> ?surname:Types.string40 -> ?title:Types.string64 -> ?locality:Types.string128 -> ?serial_number:Types.asn1_printable_string64 -> ?common_name:Types.string64 -> ?state:Types.string128 -> ?distinguished_name_qualifier:Types.asn1_printable_string64 -> ?organizational_unit:Types.string64 -> ?organization:Types.string64 -> ?country:Types.country_code_string -> unit -> Types.asn1_subject
val make_key_usage : ?decipher_only:Types.boolean_ -> ?encipher_only:Types.boolean_ -> ?crl_sign:Types.boolean_ -> ?key_cert_sign:Types.boolean_ -> ?key_agreement:Types.boolean_ -> ?data_encipherment:Types.boolean_ -> ?key_encipherment:Types.boolean_ -> ?non_repudiation:Types.boolean_ -> ?digital_signature:Types.boolean_ -> unit -> Types.key_usage
val make_access_method : ?access_method_type:Types.access_method_type -> ?custom_object_identifier:Types.custom_object_identifier -> unit -> Types.access_method
val make_edi_party_name : ?name_assigner:Types.string256 -> party_name:Types.string256 -> unit -> Types.edi_party_name
val make_general_name : ?registered_id:Types.custom_object_identifier -> ?ip_address:Types.string39 -> ?uniform_resource_identifier:Types.string253 -> ?edi_party_name:Types.edi_party_name -> ?directory_name:Types.asn1_subject -> ?dns_name:Types.string253 -> ?rfc822_name:Types.string256 -> ?other_name:Types.other_name -> unit -> Types.general_name
val make_access_description : access_location:Types.general_name -> access_method:Types.access_method -> unit -> Types.access_description
val make_csr_extensions : ?subject_information_access:Types.access_description_list -> ?key_usage:Types.key_usage -> unit -> Types.csr_extensions
val make_certificate_authority_configuration : ?csr_extensions:Types.csr_extensions -> subject:Types.asn1_subject -> signing_algorithm:Types.signing_algorithm -> key_algorithm:Types.key_algorithm -> unit -> Types.certificate_authority_configuration
val make_certificate_authority : ?usage_mode:Types.certificate_authority_usage_mode -> ?key_storage_security_standard:Types.key_storage_security_standard -> ?restorable_until:Types.t_stamp -> ?revocation_configuration:Types.revocation_configuration -> ?certificate_authority_configuration: Types.certificate_authority_configuration -> ?failure_reason:Types.failure_reason -> ?not_after:Types.t_stamp -> ?not_before:Types.t_stamp -> ?status:Types.certificate_authority_status -> ?serial:Types.string_ -> ?type_:Types.certificate_authority_type -> ?last_state_change_at:Types.t_stamp -> ?created_at:Types.t_stamp -> ?owner_account:Types.account_id -> ?arn:Types.arn -> unit -> Types.certificate_authority
val make_list_certificate_authorities_response : ?certificate_authorities:Types.certificate_authorities -> ?next_token:Types.next_token -> unit -> Types.list_certificate_authorities_response
val make_list_certificate_authorities_request : ?resource_owner:Types.resource_owner -> ?next_token:Types.next_token -> ?max_results:Types.max_results -> unit -> Types.list_certificate_authorities_request
val make_issue_certificate_response : ?certificate_arn:Types.arn -> unit -> Types.issue_certificate_response
val make_extended_key_usage : ?extended_key_usage_object_identifier:Types.custom_object_identifier -> ?extended_key_usage_type:Types.extended_key_usage_type -> unit -> Types.extended_key_usage
val make_custom_extension : ?critical:Types.boolean_ -> value:Types.base64_string1_to4096 -> object_identifier:Types.custom_object_identifier -> unit -> Types.custom_extension
val make_extensions : ?custom_extensions:Types.custom_extension_list -> ?subject_alternative_names:Types.general_name_list -> ?key_usage:Types.key_usage -> ?extended_key_usage:Types.extended_key_usage_list -> ?certificate_policies:Types.certificate_policy_list -> unit -> Types.extensions
val make_api_passthrough : ?subject:Types.asn1_subject -> ?extensions:Types.extensions -> unit -> Types.api_passthrough
val make_issue_certificate_request : ?idempotency_token:Types.idempotency_token -> ?validity_not_before:Types.validity -> ?template_arn:Types.arn -> ?api_passthrough:Types.api_passthrough -> validity:Types.validity -> signing_algorithm:Types.signing_algorithm -> csr:Types.csr_blob -> certificate_authority_arn:Types.arn -> unit -> Types.issue_certificate_request
val make_import_certificate_authority_certificate_request : ?certificate_chain:Types.certificate_chain_blob -> certificate:Types.certificate_body_blob -> certificate_authority_arn:Types.arn -> unit -> Types.import_certificate_authority_certificate_request
val make_get_policy_response : ?policy:Types.aws_policy -> unit -> Types.get_policy_response
val make_get_policy_request : resource_arn:Types.arn -> unit -> Types.get_policy_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 -> certificate_authority_arn:Types.arn -> unit -> Types.get_certificate_request
val make_get_certificate_authority_csr_response : ?csr:Types.csr_body -> unit -> Types.get_certificate_authority_csr_response
val make_get_certificate_authority_csr_request : certificate_authority_arn:Types.arn -> unit -> Types.get_certificate_authority_csr_request
val make_get_certificate_authority_certificate_response : ?certificate_chain:Types.certificate_chain -> ?certificate:Types.certificate_body -> unit -> Types.get_certificate_authority_certificate_response
val make_get_certificate_authority_certificate_request : certificate_authority_arn:Types.arn -> unit -> Types.get_certificate_authority_certificate_request
val make_describe_certificate_authority_response : ?certificate_authority:Types.certificate_authority -> unit -> Types.describe_certificate_authority_response
val make_describe_certificate_authority_request : certificate_authority_arn:Types.arn -> unit -> Types.describe_certificate_authority_request
val make_describe_certificate_authority_audit_report_response : ?created_at:Types.t_stamp -> ?s3_key:Types.s3_key -> ?s3_bucket_name:Types.s3_bucket_name -> ?audit_report_status:Types.audit_report_status -> unit -> Types.describe_certificate_authority_audit_report_response
val make_describe_certificate_authority_audit_report_request : audit_report_id:Types.audit_report_id -> certificate_authority_arn:Types.arn -> unit -> Types.describe_certificate_authority_audit_report_request
val make_delete_policy_request : resource_arn:Types.arn -> unit -> Types.delete_policy_request
val make_delete_permission_request : ?source_account:Types.account_id -> principal:Types.principal -> certificate_authority_arn:Types.arn -> unit -> Types.delete_permission_request
val make_delete_certificate_authority_request : ?permanent_deletion_time_in_days:Types.permanent_deletion_time_in_days -> certificate_authority_arn:Types.arn -> unit -> Types.delete_certificate_authority_request
val make_create_permission_request : ?source_account:Types.account_id -> actions:Types.action_list -> principal:Types.principal -> certificate_authority_arn:Types.arn -> unit -> Types.create_permission_request
val make_create_certificate_authority_response : ?certificate_authority_arn:Types.arn -> unit -> Types.create_certificate_authority_response
val make_create_certificate_authority_request : ?usage_mode:Types.certificate_authority_usage_mode -> ?tags:Types.tag_list -> ?key_storage_security_standard:Types.key_storage_security_standard -> ?idempotency_token:Types.idempotency_token -> ?revocation_configuration:Types.revocation_configuration -> certificate_authority_type:Types.certificate_authority_type -> certificate_authority_configuration:Types.certificate_authority_configuration -> unit -> Types.create_certificate_authority_request
val make_create_certificate_authority_audit_report_response : ?s3_key:Types.s3_key -> ?audit_report_id:Types.audit_report_id -> unit -> Types.create_certificate_authority_audit_report_response
val make_create_certificate_authority_audit_report_request : audit_report_response_format:Types.audit_report_response_format -> s3_bucket_name:Types.s3_bucket_name -> certificate_authority_arn:Types.arn -> unit -> Types.create_certificate_authority_audit_report_request

Operations

module CreateCertificateAuthority : sig ... end

Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, an optional configuration for Online Certificate Status Protocol (OCSP) and/or a certificate revocation list (CRL), the CA type, and an optional idempotency token to avoid accidental creation of multiple CAs. The CA configuration specifies the name of the algorithm and key size to be used to create the CA private key, the type of signing algorithm that the CA uses, and X.500 subject information. The OCSP configuration can optionally specify a custom URL for the OCSP responder. The CRL configuration specifies the CRL expiration period in days (the validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3 bucket that is included in certificates issued by the CA. If successful, this action returns the Amazon Resource Name (ARN) of the CA.

Creates an audit report that lists every time that your CA private key is used to issue a certificate. The IssueCertificate and RevokeCertificate actions use the private key.

module CreatePermission : sig ... end

Grants one or more permissions on a private CA to the Certificate Manager (ACM) service principal (acm.amazonaws.com). These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA.

module DeleteCertificateAuthority : sig ... end

Deletes a private certificate authority (CA). You must provide the Amazon Resource Name (ARN) of the private CA that you want to delete. You can find the ARN by calling the ListCertificateAuthorities action.

module DeletePermission : sig ... end

Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com).

module DeletePolicy : sig ... end

Deletes the resource-based policy attached to a private CA. Deletion will remove any access that the policy has granted. If there is no policy attached to the private CA, this action will return successful.

module DescribeCertificateAuthority : sig ... end

Lists information about your private certificate authority (CA) or one that has been shared with you. You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following:

Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport action. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the IssueCertificate action or the RevokeCertificate action.

module GetCertificate : sig ... end

Retrieves a certificate from your private CA or one that has been shared with you. The ARN of the certificate is returned when you call the IssueCertificate action. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the GetCertificate action. You can retrieve the certificate if it is in the ISSUED, EXPIRED, or REVOKED state. You can call the CreateCertificateAuthorityAuditReport action to create a report that contains information about all of the certificates issued and revoked by your private CA.

Retrieves the certificate and certificate chain for your private certificate authority (CA) or one that has been shared with you. Both the certificate and the chain are base64 PEM-encoded. The chain does not include the CA certificate. Each certificate in the chain signs the one before it.

module GetCertificateAuthorityCsr : sig ... end

Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the CreateCertificateAuthority action. Sign the CSR with your Amazon Web Services Private CA-hosted or on-premises root or subordinate CA. Then import the signed certificate back into Amazon Web Services Private CA by calling the ImportCertificateAuthorityCertificate action. The CSR is returned as a base64 PEM-encoded string.

module GetPolicy : sig ... end

Retrieves the resource-based policy attached to a private CA. If either the private CA resource or the policy cannot be found, this action returns a ResourceNotFoundException.

Imports a signed private CA certificate into Amazon Web Services Private CA. This action is used when you are using a chain of trust whose root is located outside Amazon Web Services Private CA. Before you can call this action, the following preparations must in place:

module IssueCertificate : sig ... end

Uses your private certificate authority (CA), or one that has been shared with you, to issue a client certificate. This action returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the GetCertificate action and specifying the ARN.

module ListCertificateAuthorities : sig ... end

Lists the private certificate authorities that you created by using the CreateCertificateAuthority action.

module ListPermissions : sig ... end

List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com).

module ListTags : sig ... end

Lists the tags, if any, that are associated with your private CA or one that has been shared with you. Tags are labels that you can use to identify and organize your CAs. Each tag consists of a key and an optional value. Call the TagCertificateAuthority action to add one or more tags to your CA. Call the UntagCertificateAuthority action to remove tags.

module PutPolicy : sig ... end

Attaches a resource-based policy to a private CA.

module RestoreCertificateAuthority : sig ... end

Restores a certificate authority (CA) that is in the DELETED state. You can restore a CA during the period that you defined in the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthority action. Currently, you can specify 7 to 30 days. If you did not specify a PermanentDeletionTimeInDays value, by default you can restore the CA at any time in a 30 day period. You can check the time remaining in the restoration period of a private CA in the DELETED state by calling the DescribeCertificateAuthority or ListCertificateAuthorities actions. The status of a restored CA is set to its pre-deletion status when the RestoreCertificateAuthority action returns. To change its status to ACTIVE, call the UpdateCertificateAuthority action. If the private CA was in the PENDING_CERTIFICATE state at deletion, you must use the ImportCertificateAuthorityCertificate action to import a certificate authority into the private CA before it can be activated. You cannot restore a CA after the restoration period has ended.

module RevokeCertificate : sig ... end

Revokes a certificate that was issued inside Amazon Web Services Private CA. If you enable a certificate revocation list (CRL) when you create or update your private CA, information about the revoked certificates will be included in the CRL. Amazon Web Services Private CA writes the CRL to an S3 bucket that you specify. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason the CRL update fails, Amazon Web Services Private CA attempts makes further attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics CRLGenerated and MisconfiguredCRLBucket. For more information, see Supported CloudWatch Metrics.

module TagCertificateAuthority : sig ... end

Adds one or more tags to your private CA. 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 private CA on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one private CA if you want to identify a specific characteristic of that CA, or you can apply the same tag to multiple private CAs if you want to filter for a common relationship among those CAs. To remove one or more tags, use the UntagCertificateAuthority action. Call the ListTags action to see what tags are associated with your CA.

module UntagCertificateAuthority : sig ... end

Remove one or more tags from your private CA. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this action, 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. To add tags to a private CA, use the TagCertificateAuthority. Call the ListTags action to see what tags are associated with your CA.

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