Module Smaws_Client_ACM

ACM client library built on EIO.

Types

type validation_method =
  1. | DNS
  2. | EMAIL
type validation_exception = {
  1. message : string option;
}

The supplied input failed to satisfy constraints of an Amazon Web Services service.

type certificate_transparency_logging_preference =
  1. | DISABLED
  2. | ENABLED
type certificate_options = {
  1. certificate_transparency_logging_preference : certificate_transparency_logging_preference option;
    (*

    You can opt out of certificate transparency logging by specifying the DISABLED option. Opt in by specifying ENABLED.

    *)
}

Structure that contains options for your certificate. Currently, you can use this only to specify whether to opt in to or out of certificate transparency logging. Some browsers require that public certificates issued for your domain be recorded in a log. Certificates that are not logged typically generate a browser error. Transparency makes it possible for you to detect SSL/TLS certificates that have been mistakenly or maliciously issued for your domain. For general information, see Certificate Transparency Logging.

type update_certificate_options_request = {
  1. options : certificate_options;
    (*

    Use to update the options for your certificate. Currently, you can specify whether to add your certificate to a transparency log. Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser.

    *)
  2. certificate_arn : string;
    (*

    ARN of the requested certificate to update. This must be of the form:

    arn:aws:acm:us-east-1:{i account}:certificate/{i 12345678-1234-1234-1234-123456789012}
    *)
}
type resource_not_found_exception = {
  1. message : string option;
}

The specified certificate cannot be found in the caller's account or the caller's account cannot be found.

type limit_exceeded_exception = {
  1. message : string option;
}

An ACM quota has been exceeded.

type invalid_state_exception = {
  1. message : string option;
}

Processing has reached an invalid state.

type invalid_arn_exception = {
  1. message : string option;
}

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

type too_many_tags_exception = {
  1. message : string option;
}

The request contains too many tags. Try the request again with fewer tags.

type throttling_exception = {
  1. message : string option;
}

The request was denied because it exceeded a quota.

type tag_policy_exception = {
  1. message : string option;
}

A specified tag did not comply with an existing tag policy and was rejected.

type tag = {
  1. value : string option;
    (*

    The value of the tag.

    *)
  2. key : string;
    (*

    The key of the tag.

    *)
}

A key-value pair that identifies or specifies metadata about an ACM resource.

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;
    (*

    The value of the CNAME record to add to your DNS database. This is supplied by ACM.

    *)
  2. type_ : record_type;
    (*

    The type of DNS record. Currently this can be CNAME.

    *)
  3. name : string;
    (*

    The name of the DNS record to create in your domain. This is supplied by ACM.

    *)
}

Contains a DNS record value that you can use to validate ownership or control of a domain. This is used by the DescribeCertificate action.

type resource_in_use_exception = {
  1. message : string option;
}

The certificate is in use by another Amazon Web Services service in the caller's account. Remove the association and try again.

type resend_validation_email_request = {
  1. validation_domain : string;
    (*

    The base validation domain that will act as the suffix of the email addresses that are used to send the emails. This must be the same as the Domain value or a superdomain of the Domain value. For example, if you requested a certificate for site.subdomain.example.com and specify a ValidationDomain of subdomain.example.com, ACM sends email to the domain registrant, technical contact, and administrative contact in WHOIS and the following five addresses:

    • admin@subdomain.example.com
    • administrator@subdomain.example.com
    • hostmaster@subdomain.example.com
    • postmaster@subdomain.example.com
    • webmaster@subdomain.example.com
    *)
  2. domain : string;
    (*

    The fully qualified domain name (FQDN) of the certificate that needs to be validated.

    *)
  3. certificate_arn : string;
    (*

    String that contains the ARN of the requested certificate. The certificate ARN is generated and returned by the RequestCertificate action as soon as the request is made. By default, using this parameter causes email to be sent to all top-level domains you specified in the certificate request. The ARN must be of the form:

    arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012

    *)
}
type invalid_domain_validation_options_exception = {
  1. message : string option;
}

One or more values in the DomainValidationOption structure is incorrect.

type request_in_progress_exception = {
  1. message : string option;
}

The certificate request is in process and the certificate in your account has not yet been issued.

type request_certificate_response = {
  1. certificate_arn : string option;
    (*

    String that contains the ARN of the issued certificate. This must be of the form:

    arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012

    *)
}
type domain_validation_option = {
  1. validation_domain : string;
    (*

    The domain name that you want ACM to use to send you validation emails. This domain name is the suffix of the email addresses that you want ACM to use. This must be the same as the DomainName value or a superdomain of the DomainName value. For example, if you request a certificate for testing.example.com, you can specify example.com for this value. In that case, ACM sends domain validation emails to the following five addresses:

    • admin@example.com
    • administrator@example.com
    • hostmaster@example.com
    • postmaster@example.com
    • webmaster@example.com
    *)
  2. domain_name : string;
    (*

    A fully qualified domain name (FQDN) in the certificate request.

    *)
}

Contains information about the domain names that you want ACM to use to send you emails that enable you to validate domain ownership.

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;
    (*

    Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data. RSA is the default key algorithm for ACM certificates. Elliptic Curve Digital Signature Algorithm (ECDSA) keys are smaller, offering security comparable to RSA keys but with greater computing efficiency. However, ECDSA is not supported by all network clients. Some AWS services may require RSA keys, or only support ECDSA keys of a particular size, while others allow the use of either RSA and ECDSA keys to ensure that compatibility is not broken. Check the requirements for the AWS service where you plan to deploy your certificate.

    Default: RSA_2048

    *)
  2. tags : tag list option;
    (*

    One or more resource tags to associate with the certificate.

    *)
  3. certificate_authority_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate. For more information about private CAs, see the Amazon Web Services Private Certificate Authority user guide. The ARN must have the following form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

    *)
  4. options : certificate_options option;
    (*

    Currently, you can use this parameter to specify whether to add the certificate to a certificate transparency log. Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser. For more information, see Opting Out of Certificate Transparency Logging.

    *)
  5. domain_validation_options : domain_validation_option list option;
    (*

    The domain name that you want ACM to use to send you emails so that you can validate domain ownership.

    *)
  6. idempotency_token : string option;
    (*

    Customer chosen string that can be used to distinguish between calls to RequestCertificate. Idempotency tokens time out after one hour. Therefore, if you call RequestCertificate multiple times with the same idempotency token within one hour, ACM recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, ACM recognizes that you are requesting multiple certificates.

    *)
  7. subject_alternative_names : string list option;
    (*

    Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, add the name www.example.net to a certificate for which the DomainName field is www.example.com if users can reach your site by using either name. The maximum number of domain names that you can add to an ACM certificate is 100. However, the initial quota is 10 domain names. If you need more than 10 names, you must request a quota increase. For more information, see Quotas.

    The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples:

    • (63 octets).(63 octets).(63 octets).(61 octets) is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets.
    • (64 octets).(63 octets).(63 octets).(61 octets) is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets.
    • (63 octets).(63 octets).(63 octets).(62 octets) is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.
    *)
  8. validation_method : validation_method option;
    (*

    The method you want to use if you are requesting a public certificate to validate that you own or control domain. You can validate with DNS or validate with email. We recommend that you use DNS validation.

    *)
  9. domain_name : string;
    (*

    Fully qualified domain name (FQDN), such as www.example.com, that you want to secure with an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com.

    In compliance with RFC 5280, the length of the domain name (technically, the Common Name) that you provide cannot exceed 64 octets (characters), including periods. To add a longer domain name, specify it in the Subject Alternative Name field, which supports names up to 253 octets in length.

    *)
}
type invalid_tag_exception = {
  1. message : string option;
}

One or both of the values that make up the key-value pair is not valid. For example, you cannot specify a tag value that begins with aws:.

type invalid_parameter_exception = {
  1. message : string option;
}

An input parameter was invalid.

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;
    (*

    Specifies the domain validation method.

    *)
  2. resource_record : resource_record option;
    (*

    Contains the CNAME record that you add to your DNS database for domain validation. For more information, see Use DNS to Validate Domain Ownership.

    Note: The CNAME information that you need does not include the name of your domain. If you include
 your domain name in the DNS database CNAME record, validation fails.
 For example, if the name is "_a79865eb4cd1a6ab990a45779b4e0b96.yourdomain.com", only "_a79865eb4cd1a6ab990a45779b4e0b96" must be used.

    *)
  3. validation_status : domain_status option;
    (*

    The validation status of the domain name. This can be one of the following values:

    • PENDING_VALIDATION
    • SUCCESS
    • FAILED
    *)
  4. validation_domain : string option;
    (*

    The domain name that ACM used to send domain validation emails.

    *)
  5. validation_emails : string list option;
    (*

    A list of email addresses that ACM used to send domain validation emails.

    *)
  6. domain_name : string;
    (*

    A fully qualified domain name (FQDN) in the certificate. For example, www.example.com or example.com.

    *)
}

Contains information about the validation of each domain name in the certificate.

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;
    (*

    The time at which the renewal summary was last updated.

    *)
  2. renewal_status_reason : failure_reason option;
    (*

    The reason that a renewal request was unsuccessful.

    *)
  3. domain_validation_options : domain_validation list;
    (*

    Contains information about the validation of each domain name in the certificate, as it pertains to ACM's managed renewal. This is different from the initial validation that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED.

    *)
  4. renewal_status : renewal_status;
    (*

    The status of ACM's managed renewal of the certificate.

    *)
}

Contains information about the status of ACM's managed renewal for the certificate. This structure exists only when the certificate type is AMAZON_ISSUED.

type renewal_eligibility =
  1. | INELIGIBLE
  2. | ELIGIBLE
type renew_certificate_request = {
  1. certificate_arn : string;
    (*

    String that contains the ARN of the ACM certificate to be renewed. This must be of the form:

    arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

    For more information about ARNs, see Amazon Resource Names (ARNs).

    *)
}
type remove_tags_from_certificate_request = {
  1. tags : tag list;
    (*

    The key-value pair that defines the tag to remove.

    *)
  2. certificate_arn : string;
    (*

    String that contains the ARN of the ACM Certificate with one or more tags that you want to remove. This must be of the form:

    arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

    For more information about ARNs, see Amazon Resource Names (ARNs).

    *)
}
type expiry_events_configuration = {
  1. days_before_expiry : int option;
    (*

    Specifies the number of days prior to certificate expiration when ACM starts generating EventBridge events. ACM sends one event per day per certificate until the certificate expires. By default, accounts receive events starting 45 days before certificate expiration.

    *)
}

Object containing expiration events options associated with an Amazon Web Services account.

type put_account_configuration_request = {
  1. idempotency_token : string;
    (*

    Customer-chosen string used to distinguish between calls to PutAccountConfiguration. Idempotency tokens time out after one hour. If you call PutAccountConfiguration multiple times with the same unexpired idempotency token, ACM treats it as the same request and returns the original result. If you change the idempotency token for each call, ACM treats each call as a new request.

    *)
  2. expiry_events : expiry_events_configuration option;
    (*

    Specifies expiration events associated with an account.

    *)
}
type conflict_exception = {
  1. message : string option;
}

You are trying to update a resource or configuration that is already being created or updated. Wait for the previous operation to finish and try again.

type access_denied_exception = {
  1. message : string option;
}

You do not have access required to perform this action.

type list_tags_for_certificate_response = {
  1. tags : tag list option;
    (*

    The key-value pairs that define the applied tags.

    *)
}
type list_tags_for_certificate_request = {
  1. certificate_arn : string;
    (*

    String that contains the ARN of the ACM certificate for which you want to list the tags. This must have the following form:

    arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

    For more information about ARNs, see Amazon Resource Names (ARNs).

    *)
}
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;
    (*

    The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED.

    *)
  2. imported_at : float option;
    (*

    The date and time when the certificate was imported. This value exists only when the certificate type is IMPORTED.

    *)
  3. issued_at : float option;
    (*

    The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED.

    *)
  4. created_at : float option;
    (*

    The time at which the certificate was requested.

    *)
  5. not_after : float option;
    (*

    The time after which the certificate is not valid.

    *)
  6. not_before : float option;
    (*

    The time before which the certificate is not valid.

    *)
  7. renewal_eligibility : renewal_eligibility option;
    (*

    Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.

    *)
  8. exported : bool option;
    (*

    Indicates whether the certificate has been exported. This value exists only when the certificate type is PRIVATE.

    *)
  9. in_use : bool option;
    (*

    Indicates whether the certificate is currently in use by any Amazon Web Services resources.

    *)
  10. extended_key_usages : extended_key_usage_name list option;
    (*

    Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).

    *)
  11. key_usages : key_usage_name list option;
    (*

    A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.

    *)
  12. key_algorithm : key_algorithm option;
    (*

    The algorithm that was used to generate the public-private key pair.

    *)
  13. type_ : certificate_type option;
    (*

    The source of the certificate. For certificates provided by ACM, this value is AMAZON_ISSUED. For certificates that you imported with ImportCertificate, this value is IMPORTED. ACM does not provide managed renewal for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see Importing Certificates in the Certificate Manager User Guide.

    *)
  14. status : certificate_status option;
    (*

    The status of the certificate.

    A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic Certificate request fails. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation, and try again. If validation succeeds, the certificate enters status ISSUED.

    *)
  15. has_additional_subject_alternative_names : bool option;
    (*

    When called by ListCertificates, indicates whether the full list of subject alternative names has been included in the response. If false, the response includes all of the subject alternative names included in the certificate. If true, the response only includes the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.

    *)
  16. subject_alternative_name_summaries : string list option;
    (*

    One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.

    When called by ListCertificates, this parameter will only return the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.

    *)
  17. domain_name : string option;
    (*

    Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.

    *)
  18. certificate_arn : string option;
    (*

    Amazon Resource Name (ARN) of the certificate. This is of the form:

    arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

    For more information about ARNs, see Amazon Resource Names (ARNs).

    *)
}

This structure is returned in the response object of ListCertificates action.

type list_certificates_response = {
  1. certificate_summary_list : certificate_summary list option;
    (*

    A list of ACM certificates.

    *)
  2. next_token : string option;
    (*

    When the list is truncated, this value is present and contains the value to use for the NextToken parameter in a subsequent pagination request.

    *)
}
type filters = {
  1. key_types : key_algorithm list option;
    (*

    Specify one or more algorithms that can be used to generate key pairs.

    Default filtering returns only RSA_1024 and RSA_2048 certificates that have at least one domain. To return other certificate types, provide the desired type signatures in a comma-separated list. For example, "keyTypes": ["RSA_2048","RSA_4096"] returns both RSA_2048 and RSA_4096 certificates.

    *)
  2. key_usage : key_usage_name list option;
    (*

    Specify one or more KeyUsage extension values.

    *)
  3. extended_key_usage : extended_key_usage_name list option;
    (*

    Specify one or more ExtendedKeyUsage extension values.

    *)
}

This structure can be used in the ListCertificates action to filter the output of the certificate list.

type list_certificates_request = {
  1. sort_order : sort_order option;
    (*

    Specifies the order of sorted results. If you specify SortOrder, you must also specify SortBy.

    *)
  2. sort_by : sort_by option;
    (*

    Specifies the field to sort results by. If you specify SortBy, you must also specify SortOrder.

    *)
  3. max_items : int option;
    (*

    Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.

    *)
  4. next_token : string option;
    (*

    Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received.

    *)
  5. includes : filters option;
    (*

    Filter the certificate list. For more information, see the Filters structure.

    *)
  6. certificate_statuses : certificate_status list option;
    (*

    Filter the certificate list by status value.

    *)
}
type invalid_args_exception = {
  1. message : string option;
}

One or more of of request parameters specified is not valid.

type key_usage = {
  1. name : key_usage_name option;
    (*

    A string value that contains a Key Usage extension name.

    *)
}

The Key Usage X.509 v3 extension defines the purpose of the public key contained in the certificate.

type import_certificate_response = {
  1. certificate_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the imported certificate.

    *)
}
type import_certificate_request = {
  1. tags : tag list option;
    (*

    One or more resource tags to associate with the imported certificate.

    Note: You cannot apply tags when reimporting a certificate.

    *)
  2. certificate_chain : bytes option;
    (*

    The PEM encoded certificate chain.

    *)
  3. private_key : bytes;
    (*

    The private key that matches the public key in the certificate.

    *)
  4. certificate : bytes;
    (*

    The certificate to import.

    *)
  5. certificate_arn : string option;
    (*

    The Amazon Resource Name (ARN) of an imported certificate to replace. To import a new certificate, omit this field.

    *)
}
type get_certificate_response = {
  1. certificate_chain : string option;
    (*

    Certificates forming the requested certificate's chain of trust. The chain consists of the certificate of the issuing CA and the intermediate certificates of any other subordinate CAs.

    *)
  2. certificate : string option;
    (*

    The ACM-issued certificate corresponding to the ARN specified as input.

    *)
}
type get_certificate_request = {
  1. certificate_arn : string;
    (*

    String that contains a certificate ARN in the following format:

    arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

    For more information about ARNs, see Amazon Resource Names (ARNs).

    *)
}
type get_account_configuration_response = {
  1. expiry_events : expiry_events_configuration option;
    (*

    Expiration events configuration options associated with the Amazon Web Services account.

    *)
}
type extended_key_usage = {
  1. oi_d : string option;
    (*

    An object identifier (OID) for the extension value. OIDs are strings of numbers separated by periods. The following OIDs are defined in RFC 3280 and RFC 5280.

    • 1.3.6.1.5.5.7.3.1 (TLS_WEB_SERVER_AUTHENTICATION)
    • 1.3.6.1.5.5.7.3.2 (TLS_WEB_CLIENT_AUTHENTICATION)
    • 1.3.6.1.5.5.7.3.3 (CODE_SIGNING)
    • 1.3.6.1.5.5.7.3.4 (EMAIL_PROTECTION)
    • 1.3.6.1.5.5.7.3.8 (TIME_STAMPING)
    • 1.3.6.1.5.5.7.3.9 (OCSP_SIGNING)
    • 1.3.6.1.5.5.7.3.5 (IPSEC_END_SYSTEM)
    • 1.3.6.1.5.5.7.3.6 (IPSEC_TUNNEL)
    • 1.3.6.1.5.5.7.3.7 (IPSEC_USER)
    *)
  2. name : extended_key_usage_name option;
    (*

    The name of an Extended Key Usage value.

    *)
}

The Extended Key Usage X.509 v3 extension defines one or more purposes for which the public key can be used. This is in addition to or in place of the basic purposes specified by the Key Usage extension.

type export_certificate_response = {
  1. private_key : string option;
    (*

    The encrypted private key associated with the public key in the certificate. The key is output in PKCS #8 format and is base64 PEM-encoded.

    *)
  2. certificate_chain : string option;
    (*

    The base64 PEM-encoded certificate chain. This does not include the certificate that you are exporting.

    *)
  3. certificate : string option;
    (*

    The base64 PEM-encoded certificate.

    *)
}
type export_certificate_request = {
  1. passphrase : bytes;
    (*

    Passphrase to associate with the encrypted exported private key.

    When creating your passphrase, you can use any ASCII character except #, $, or %.

    If you want to later decrypt the private key, you must have the passphrase. You can use the following OpenSSL command to decrypt a private key. After entering the command, you are prompted for the passphrase.

    openssl rsa -in encrypted_key.pem -out decrypted_key.pem

    *)
  2. certificate_arn : string;
    (*

    An Amazon Resource Name (ARN) of the issued certificate. This must be of the form:

    arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012

    *)
}
type certificate_detail = {
  1. options : certificate_options option;
    (*

    Value that specifies whether to add the certificate to a transparency log. Certificate transparency makes it possible to detect SSL certificates that have been mistakenly or maliciously issued. A browser might respond to certificate that has not been logged by showing an error message. The logs are cryptographically secure.

    *)
  2. renewal_eligibility : renewal_eligibility option;
    (*

    Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.

    *)
  3. certificate_authority_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the private certificate authority (CA) that issued the certificate. This has the following format:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

    *)
  4. extended_key_usages : extended_key_usage list option;
    (*

    Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).

    *)
  5. key_usages : key_usage list option;
    (*

    A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.

    *)
  6. renewal_summary : renewal_summary option;
    (*

    Contains information about the status of ACM's managed renewal for the certificate. This field exists only when the certificate type is AMAZON_ISSUED.

    *)
  7. type_ : certificate_type option;
    (*

    The source of the certificate. For certificates provided by ACM, this value is AMAZON_ISSUED. For certificates that you imported with ImportCertificate, this value is IMPORTED. ACM does not provide managed renewal for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see Importing Certificates in the Certificate Manager User Guide.

    *)
  8. failure_reason : failure_reason option;
    (*

    The reason the certificate request failed. This value exists only when the certificate status is FAILED. For more information, see Certificate Request Failed in the Certificate Manager User Guide.

    *)
  9. in_use_by : string list option;
    (*

    A list of ARNs for the Amazon Web Services resources that are using the certificate. A certificate can be used by multiple Amazon Web Services resources.

    *)
  10. signature_algorithm : string option;
    (*

    The algorithm that was used to sign the certificate.

    *)
  11. key_algorithm : key_algorithm option;
    (*

    The algorithm that was used to generate the public-private key pair.

    *)
  12. not_after : float option;
    (*

    The time after which the certificate is not valid.

    *)
  13. not_before : float option;
    (*

    The time before which the certificate is not valid.

    *)
  14. revocation_reason : revocation_reason option;
    (*

    The reason the certificate was revoked. This value exists only when the certificate status is REVOKED.

    *)
  15. revoked_at : float option;
    (*

    The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED.

    *)
  16. status : certificate_status option;
    (*

    The status of the certificate.

    A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic Certificate request fails. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation, and try again. If validation succeeds, the certificate enters status ISSUED.

    *)
  17. imported_at : float option;
    (*

    The date and time when the certificate was imported. This value exists only when the certificate type is IMPORTED.

    *)
  18. issued_at : float option;
    (*

    The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED.

    *)
  19. created_at : float option;
    (*

    The time at which the certificate was requested.

    *)
  20. issuer : string option;
    (*

    The name of the certificate authority that issued and signed the certificate.

    *)
  21. subject : string option;
    (*

    The name of the entity that is associated with the public key contained in the certificate.

    *)
  22. serial : string option;
    (*

    The serial number of the certificate.

    *)
  23. domain_validation_options : domain_validation list option;
    (*

    Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED.

    *)
  24. subject_alternative_names : string list option;
    (*

    One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.

    *)
  25. domain_name : string option;
    (*

    The fully qualified domain name for the certificate, such as www.example.com or example.com.

    *)
  26. certificate_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

    *)
}

Contains metadata about an ACM certificate. This structure is returned in the response to a DescribeCertificate request.

type describe_certificate_response = {
  1. certificate : certificate_detail option;
    (*

    Metadata about an ACM certificate.

    *)
}
type describe_certificate_request = {
  1. certificate_arn : string;
    (*

    The Amazon Resource Name (ARN) of the ACM certificate. The ARN must have the following form:

    arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

    For more information about ARNs, see Amazon Resource Names (ARNs).

    *)
}
type delete_certificate_request = {
  1. certificate_arn : string;
    (*

    String that contains the ARN of the ACM certificate to be deleted. This must be of the form:

    arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

    For more information about ARNs, see Amazon Resource Names (ARNs).

    *)
}
type add_tags_to_certificate_request = {
  1. tags : tag list;
    (*

    The key-value pair that defines the tag. The tag value is optional.

    *)
  2. certificate_arn : string;
    (*

    String that contains the ARN of the ACM certificate to which the tag is to be applied. This must be of the form:

    arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

    For more information about ARNs, see Amazon Resource Names (ARNs).

    *)
}

Certificate Manager You can use Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites and applications. For more information about using ACM, see the Certificate Manager User Guide.

type base_document = Smaws_Lib.Json.t

Builders

val make_certificate_options : ?certificate_transparency_logging_preference: certificate_transparency_logging_preference -> unit -> certificate_options

Create a certificate_options type

val make_update_certificate_options_request : options:certificate_options -> certificate_arn:string -> unit -> update_certificate_options_request

Create a update_certificate_options_request type

val make_tag : ?value:string -> key:string -> unit -> tag

Create a tag type

val make_resource_record : value:string -> type_:record_type -> name:string -> unit -> resource_record

Create a resource_record type

val make_resend_validation_email_request : validation_domain:string -> domain:string -> certificate_arn:string -> unit -> resend_validation_email_request

Create a resend_validation_email_request type

val make_request_certificate_response : ?certificate_arn:string -> unit -> request_certificate_response

Create a request_certificate_response type

val make_domain_validation_option : validation_domain:string -> domain_name:string -> unit -> domain_validation_option

Create a domain_validation_option type

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

Create a request_certificate_request type

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

Create a domain_validation type

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

Create a renewal_summary type

val make_renew_certificate_request : certificate_arn:string -> unit -> renew_certificate_request

Create a renew_certificate_request type

val make_remove_tags_from_certificate_request : tags:tag list -> certificate_arn:string -> unit -> remove_tags_from_certificate_request

Create a remove_tags_from_certificate_request type

val make_expiry_events_configuration : ?days_before_expiry:int -> unit -> expiry_events_configuration

Create a expiry_events_configuration type

val make_put_account_configuration_request : ?expiry_events:expiry_events_configuration -> idempotency_token:string -> unit -> put_account_configuration_request

Create a put_account_configuration_request type

val make_list_tags_for_certificate_response : ?tags:tag list -> unit -> list_tags_for_certificate_response

Create a list_tags_for_certificate_response type

val make_list_tags_for_certificate_request : certificate_arn:string -> unit -> list_tags_for_certificate_request

Create a list_tags_for_certificate_request type

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

Create a certificate_summary type

val make_list_certificates_response : ?certificate_summary_list:certificate_summary list -> ?next_token:string -> unit -> list_certificates_response

Create a list_certificates_response type

val make_filters : ?key_types:key_algorithm list -> ?key_usage:key_usage_name list -> ?extended_key_usage:extended_key_usage_name list -> unit -> filters

Create a filters type

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

Create a list_certificates_request type

val make_key_usage : ?name:key_usage_name -> unit -> key_usage

Create a key_usage type

val make_import_certificate_response : ?certificate_arn:string -> unit -> import_certificate_response

Create a import_certificate_response type

val make_import_certificate_request : ?tags:tag list -> ?certificate_chain:bytes -> ?certificate_arn:string -> private_key:bytes -> certificate:bytes -> unit -> import_certificate_request

Create a import_certificate_request type

val make_get_certificate_response : ?certificate_chain:string -> ?certificate:string -> unit -> get_certificate_response

Create a get_certificate_response type

val make_get_certificate_request : certificate_arn:string -> unit -> get_certificate_request

Create a get_certificate_request type

val make_get_account_configuration_response : ?expiry_events:expiry_events_configuration -> unit -> get_account_configuration_response

Create a get_account_configuration_response type

val make_extended_key_usage : ?oi_d:string -> ?name:extended_key_usage_name -> unit -> extended_key_usage

Create a extended_key_usage type

val make_export_certificate_response : ?private_key:string -> ?certificate_chain:string -> ?certificate:string -> unit -> export_certificate_response

Create a export_certificate_response type

val make_export_certificate_request : passphrase:bytes -> certificate_arn:string -> unit -> export_certificate_request

Create a export_certificate_request type

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

Create a certificate_detail type

val make_describe_certificate_response : ?certificate:certificate_detail -> unit -> describe_certificate_response

Create a describe_certificate_response type

val make_describe_certificate_request : certificate_arn:string -> unit -> describe_certificate_request

Create a describe_certificate_request type

val make_delete_certificate_request : certificate_arn:string -> unit -> delete_certificate_request

Create a delete_certificate_request type

val make_add_tags_to_certificate_request : tags:tag list -> certificate_arn:string -> unit -> add_tags_to_certificate_request

Create a add_tags_to_certificate_request type

Operations

module AddTagsToCertificate : sig ... end
module DeleteCertificate : sig ... end
module DescribeCertificate : sig ... end
module ExportCertificate : sig ... end
module GetAccountConfiguration : sig ... end
module GetCertificate : sig ... end
module ImportCertificate : sig ... end
module ListCertificates : sig ... end
module ListTagsForCertificate : sig ... end
module PutAccountConfiguration : sig ... end
module RemoveTagsFromCertificate : sig ... end
module RenewCertificate : sig ... end
module RequestCertificate : sig ... end
module ResendValidationEmail : sig ... end
module UpdateCertificateOptions : sig ... end