Module Smaws_Client_ACMPCA.Types

type nonrec validity_period_type =
  1. | YEARS
  2. | MONTHS
  3. | DAYS
  4. | ABSOLUTE
  5. | END_DATE
type nonrec positive_long = Smaws_Lib.CoreTypes.Int64.t
type nonrec validity = {
  1. type_ : validity_period_type;
    (*

    Determines how Amazon Web Services Private CA interprets the Value parameter, an integer. Supported validity types include those listed below. Type definitions with values include a sample input value and the resulting output.

    END_DATE: The specific date and time when the certificate will expire, expressed using UTCTime (YYMMDDHHMMSS) or GeneralizedTime (YYYYMMDDHHMMSS) format. When UTCTime is used, if the year field (YY) is greater than or equal to 50, the year is interpreted as 19YY. If the year field is less than 50, the year is interpreted as 20YY.

    • Sample input value: 491231235959 (UTCTime format)
    • Output expiration date/time: 12/31/2049 23:59:59

    ABSOLUTE: The specific date and time when the validity of a certificate will start or expire, expressed in seconds since the Unix Epoch.

    • Sample input value: 2524608000
    • Output expiration date/time: 01/01/2050 00:00:00

    DAYS, MONTHS, YEARS: The relative time from the moment of issuance until the certificate will expire, expressed in days, months, or years.

    Example if DAYS, issued on 10/12/2020 at 12:34:54 UTC:

    • Sample input value: 90
    • Output expiration date: 01/10/2020 12:34:54 UTC

    The minimum validity duration for a certificate using relative time (DAYS) is one day. The minimum validity for a certificate using absolute time (ABSOLUTE or END_DATE) is one second.

    *)
  2. value : positive_long;
    (*

    A long integer interpreted according to the value of Type, below.

    *)
}

Validity specifies the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the validity of a certificate starts or expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280.

Amazon Web Services Private CA API consumes the Validity data type differently in two distinct parameters of the IssueCertificate action. The required parameter IssueCertificate:Validity specifies the end of a certificate's validity period. The optional parameter IssueCertificate:ValidityNotBefore specifies a customized starting time for the validity period.

type nonrec arn = string
type nonrec boolean_ = bool
type nonrec integer1_to5000 = int
type nonrec cname_string = string
type nonrec s3_bucket_name3_to255 = string
type nonrec s3_object_acl =
  1. | BUCKET_OWNER_FULL_CONTROL
  2. | PUBLIC_READ
type nonrec crl_distribution_point_extension_configuration = {
  1. omit_extension : boolean_;
    (*

    Configures whether the CRL Distribution Point extension should be populated with the default URL to the CRL. If set to true, then the CDP extension will not be present in any certificates issued by that CA unless otherwise specified through CSR or API passthrough.

    Only set this if you have another way to distribute the CRL Distribution Points ffor certificates issued by your CA, such as the Matter Distributed Compliance Ledger

    This configuration cannot be enabled with a custom CNAME set.

    *)
}

Contains configuration information for the default behavior of the CRL Distribution Point (CDP) extension in certificates issued by your CA. This extension contains a link to download the CRL, so you can check whether a certificate has been revoked. To choose whether you want this extension omitted or not in certificates issued by your CA, you can set the OmitExtension parameter.

type nonrec crl_type =
  1. | PARTITIONED
  2. | COMPLETE
type nonrec crl_path_string = string
type nonrec crl_configuration = {
  1. custom_path : crl_path_string option;
    (*

    Designates a custom file path in S3 for CRL(s). For example, http://<CustomName>/ <CustomPath>/<CrlPartition_GUID>.crl.

    *)
  2. crl_type : crl_type option;
    (*

    Specifies whether to create a complete or partitioned CRL. This setting determines the maximum number of certificates that the certificate authority can issue and revoke. For more information, see Amazon Web Services Private CA quotas.

    • COMPLETE - The default setting. Amazon Web Services Private CA maintains a single CRL file for all unexpired certificates issued by a CA that have been revoked for any reason. Each certificate that Amazon Web Services Private CA issues is bound to a specific CRL through its CRL distribution point (CDP) extension, defined in RFC 5280.

    • PARTITIONED - Compared to complete CRLs, partitioned CRLs dramatically increase the number of certificates your private CA can issue.

      When using partitioned CRLs, you must validate that the CRL's associated issuing distribution point (IDP) URI matches the certificate's CDP URI to ensure the right CRL has been fetched. Amazon Web Services Private CA marks the IDP extension as critical, which your client must be able to process.

    *)
  3. crl_distribution_point_extension_configuration : crl_distribution_point_extension_configuration option;
    (*

    Configures the behavior of the CRL Distribution Point extension for certificates issued by your certificate authority. If this field is not provided, then the CRl Distribution Point Extension will be present and contain the default CRL URL.

    *)
  4. s3_object_acl : s3_object_acl option;
    (*

    Determines whether the CRL will be publicly readable or privately held in the CRL Amazon S3 bucket. If you choose PUBLIC_READ, the CRL will be accessible over the public internet. If you choose BUCKET_OWNER_FULL_CONTROL, only the owner of the CRL S3 bucket can access the CRL, and your PKI clients may need an alternative method of access.

    If no value is specified, the default is PUBLIC_READ.

    Note: This default can cause CA creation to fail in some circumstances. If you have have enabled the Block Public Access (BPA) feature in your S3 account, then you must specify the value of this parameter as BUCKET_OWNER_FULL_CONTROL, and not doing so results in an error. If you have disabled BPA in S3, then you can specify either BUCKET_OWNER_FULL_CONTROL or PUBLIC_READ as the value.

    For more information, see Blocking public access to the S3 bucket.

    *)
  5. s3_bucket_name : s3_bucket_name3_to255 option;
    (*

    Name of the S3 bucket that contains the CRL. If you do not provide a value for the CustomCname argument, the name of your S3 bucket is placed into the CRL Distribution Points extension of the issued certificate. You can change the name of your bucket by calling the UpdateCertificateAuthority operation. You must specify a bucket policy that allows Amazon Web Services Private CA to write the CRL to your bucket.

    The S3BucketName parameter must conform to the S3 bucket naming rules.

    *)
  6. custom_cname : cname_string option;
    (*

    Name inserted into the certificate CRL Distribution Points extension that enables the use of an alias for the CRL distribution point. Use this value if you don't want the name of your S3 bucket to be public.

    The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as "http://" or "https://".

    *)
  7. expiration_in_days : integer1_to5000 option;
    (*

    Validity period of the CRL in days.

    *)
  8. enabled : boolean_;
    (*

    Boolean value that specifies whether certificate revocation lists (CRLs) are enabled. You can use this value to enable certificate revocation for a new CA when you call the CreateCertificateAuthority action or for an existing CA when you call the UpdateCertificateAuthority action.

    *)
}

Contains configuration information for a certificate revocation list (CRL). Your private certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You can enable CRLs for your new or an existing private CA by setting the Enabled parameter to true. Your private CA writes CRLs to an S3 bucket that you specify in the S3BucketName parameter. You can hide the name of your bucket by specifying a value for the CustomCname parameter. Your private CA by default copies the CNAME or the S3 bucket name to the CRL Distribution Points extension of each certificate it issues. If you want to configure this default behavior to be something different, you can set the CrlDistributionPointExtensionConfiguration parameter. Your S3 bucket policy must give write permission to Amazon Web Services Private CA.

Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs.

Your private CA uses the value in the ExpirationInDays parameter to calculate the nextUpdate field in the CRL. The CRL is refreshed prior to a certificate's expiration date or when a certificate is revoked. When a certificate is revoked, it appears in the CRL until the certificate expires, and then in one additional CRL after expiration, and it always appears in the audit report.

A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason a CRL update fails, Amazon Web Services Private CA makes further attempts every 15 minutes.

CRLs contain the following fields:

  • Version: The current version number defined in RFC 5280 is V2. The integer value is 0x1.
  • Signature Algorithm: The name of the algorithm used to sign the CRL.
  • Issuer: The X.500 distinguished name of your private CA that issued the CRL.
  • Last Update: The issue date and time of this CRL.
  • Next Update: The day and time by which the next CRL will be issued.

  • Revoked Certificates: List of revoked certificates. Each list item contains the following information.

    • Serial Number: The serial number, in hexadecimal format, of the revoked certificate.
    • Revocation Date: Date and time the certificate was revoked.

    • CRL Entry Extensions: Optional extensions for the CRL entry.

      • X509v3 CRL Reason Code: Reason the certificate was revoked.

  • CRL Extensions: Optional extensions for the CRL.

    • X509v3 Authority Key Identifier: Identifies the public key associated with the private key used to sign the certificate.
    • X509v3 CRL Number:: Decimal sequence number for the CRL.
  • Signature Algorithm: Algorithm used by your private CA to sign the CRL.
  • Signature Value: Signature computed over the CRL.

Certificate revocation lists created by Amazon Web Services Private CA are DER-encoded. You can use the following OpenSSL command to list a CRL.

openssl crl -inform DER -text -in {i crl_path} -noout

For more information, see Planning a certificate revocation list (CRL) in the Amazon Web Services Private Certificate Authority User Guide

type nonrec ocsp_configuration = {
  1. ocsp_custom_cname : cname_string option;
    (*

    By default, Amazon Web Services Private CA injects an Amazon Web Services domain into certificates being validated by the Online Certificate Status Protocol (OCSP). A customer can alternatively use this object to define a CNAME specifying a customized OCSP domain.

    The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as "http://" or "https://".

    For more information, see Customizing Online Certificate Status Protocol (OCSP) in the Amazon Web Services Private Certificate Authority User Guide.

    *)
  2. enabled : boolean_;
    (*

    Flag enabling use of the Online Certificate Status Protocol (OCSP) for validating certificate revocation status.

    *)
}

Contains information to enable and configure Online Certificate Status Protocol (OCSP) for validating certificate revocation status.

When you revoke a certificate, OCSP responses may take up to 60 minutes to reflect the new status.

type nonrec revocation_configuration = {
  1. ocsp_configuration : ocsp_configuration option;
    (*

    Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained by your private CA. When you revoke a certificate, OCSP responses may take up to 60 minutes to reflect the new status.

    *)
  2. crl_configuration : crl_configuration option;
    (*

    Configuration of the certificate revocation list (CRL), if any, maintained by your private CA. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason a CRL update fails, Amazon Web Services Private CA makes further attempts every 15 minutes.

    *)
}

Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions. Your private certificate authority (CA) can configure Online Certificate Status Protocol (OCSP) support and/or maintain a certificate revocation list (CRL). OCSP returns validation information about certificates as requested by clients, and a CRL contains an updated list of certificates revoked by your CA. For more information, see RevokeCertificate and Setting up a certificate revocation method in the Amazon Web Services Private Certificate Authority User Guide.

type nonrec certificate_authority_status =
  1. | FAILED
  2. | EXPIRED
  3. | DISABLED
  4. | DELETED
  5. | ACTIVE
  6. | PENDING_CERTIFICATE
  7. | CREATING
type nonrec update_certificate_authority_request = {
  1. status : certificate_authority_status option;
    (*

    Status of your private CA.

    *)
  2. revocation_configuration : revocation_configuration option;
    (*

    Contains information to enable support for Online Certificate Status Protocol (OCSP), certificate revocation list (CRL), both protocols, or neither. If you don't supply this parameter, existing capibilites remain unchanged. For more information, see the OcspConfiguration and CrlConfiguration types.

    The following requirements apply to revocation configurations.

    • A configuration disabling CRLs or OCSP must contain only the Enabled=False parameter, and will fail if other parameters such as CustomCname or ExpirationInDays are included.
    • In a CRL configuration, the S3BucketName parameter must conform to Amazon S3 bucket naming rules.
    • A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.
    • In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as "http://" or "https://".

    If you update the S3BucketName of CrlConfiguration, you can break revocation for existing certificates. In other words, if you call UpdateCertificateAuthority to update the CRL configuration's S3 bucket name, Amazon Web Services Private CA only writes CRLs to the new S3 bucket. Certificates issued prior to this point will have the old S3 bucket name in your CRL Distribution Point (CDP) extension, essentially breaking revocation. If you must update the S3 bucket, you'll need to reissue old certificates to keep the revocation working. Alternatively, you can use a CustomCname in your CRL configuration if you might need to change the S3 bucket name in the future.

    *)
  3. certificate_authority_arn : arn;
    (*

    Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:

    arn:aws:acm-pca:{i region}:{i account}:certificate-authority/{i 12345678-1234-1234-1234-123456789012}
    *)
}
type nonrec string_ = string
type nonrec resource_not_found_exception = {
  1. message : string_ option;
}

A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.

type nonrec invalid_state_exception = {
  1. message : string_ option;
}

The state of the private CA does not allow this action to occur.

type nonrec invalid_policy_exception = {
  1. message : string_ option;
}

The resource policy is invalid or is missing a required statement. For general information about IAM policy and statement structure, see Overview of JSON Policies.

type nonrec invalid_arn_exception = {
  1. message : string_ option;
}

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

type nonrec invalid_args_exception = {
  1. message : string_ option;
}

One or more of the specified arguments was not valid.

type nonrec concurrent_modification_exception = {
  1. message : string_ option;
}

A previous update to your private CA is still ongoing.

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

    Value of the tag.

    *)
  2. key : tag_key;
    (*

    Key (name) of the tag.

    *)
}

Tags are labels that you can use to identify and organize your private CAs. Each tag consists of a key and an optional value. You can associate up to 50 tags with a private CA. To add one or more tags to a private CA, call the TagCertificateAuthority action. To remove a tag, call the UntagCertificateAuthority action.

type nonrec tag_list = tag list
type nonrec untag_certificate_authority_request = {
  1. tags : tag_list;
    (*

    List of tags to be removed from the CA.

    *)
  2. certificate_authority_arn : arn;
    (*

    The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

    arn:aws:acm-pca:{i region}:{i account}:certificate-authority/{i 12345678-1234-1234-1234-123456789012}
    *)
}
type nonrec invalid_tag_exception = {
  1. message : string_ option;
}

The tag associated with the CA is not valid. The invalid argument is contained in the message field.

type nonrec too_many_tags_exception = {
  1. message : string_ option;
}

You can associate up to 50 tags with a private CA. Exception information is contained in the exception message field.

type nonrec tag_certificate_authority_request = {
  1. tags : tag_list;
    (*

    List of tags to be associated with the CA.

    *)
  2. certificate_authority_arn : arn;
    (*

    The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

    arn:aws:acm-pca:{i region}:{i account}:certificate-authority/{i 12345678-1234-1234-1234-123456789012}
    *)
}
type nonrec t_stamp = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec string64 = string
type nonrec string5 = string
type nonrec string40 = string
type nonrec string39 = string
type nonrec string3 = string
type nonrec string256 = string
type nonrec string253 = string
type nonrec string1_to256 = string
type nonrec string16 = string
type nonrec string128 = string
type nonrec signing_algorithm =
  1. | ML_DSA_87
  2. | ML_DSA_65
  3. | ML_DSA_44
  4. | SM3WITHSM2
  5. | SHA512WITHRSA
  6. | SHA384WITHRSA
  7. | SHA256WITHRSA
  8. | SHA512WITHECDSA
  9. | SHA384WITHECDSA
  10. | SHA256WITHECDSA
type nonrec s3_key = string
type nonrec s3_bucket_name = string
type nonrec revocation_reason =
  1. | A_A_COMPROMISE
  2. | PRIVILEGE_WITHDRAWN
  3. | CESSATION_OF_OPERATION
  4. | SUPERSEDED
  5. | AFFILIATION_CHANGED
  6. | CERTIFICATE_AUTHORITY_COMPROMISE
  7. | KEY_COMPROMISE
  8. | UNSPECIFIED
type nonrec revoke_certificate_request = {
  1. revocation_reason : revocation_reason;
    (*

    Specifies why you revoked the certificate.

    *)
  2. certificate_serial : string128;
    (*

    Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling GetCertificate with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The GetCertificate action retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number.

    openssl x509 -in {i file_path} -text -noout

    You can also copy the serial number from the console or use the DescribeCertificate action in the Certificate Manager API Reference.

    *)
  3. certificate_authority_arn : arn;
    (*

    Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:

    arn:aws:acm-pca:{i region}:{i account}:certificate-authority/{i 12345678-1234-1234-1234-123456789012}
    *)
}
type nonrec request_in_progress_exception = {
  1. message : string_ option;
}

Your request is already in progress.

type nonrec request_failed_exception = {
  1. message : string_ option;
}

The request has failed for an unspecified reason.

type nonrec request_already_processed_exception = {
  1. message : string_ option;
}

Your request has already been completed.

type nonrec limit_exceeded_exception = {
  1. message : string_ option;
}

An Amazon Web Services Private CA quota has been exceeded. See the exception message returned to determine the quota that was exceeded.

type nonrec invalid_request_exception = {
  1. message : string_ option;
}

The request action cannot be performed or is prohibited.

type nonrec restore_certificate_authority_request = {
  1. certificate_authority_arn : arn;
    (*

    The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:

    arn:aws:acm-pca:{i region}:{i account}:certificate-authority/{i 12345678-1234-1234-1234-123456789012}
    *)
}
type nonrec resource_owner =
  1. | OTHER_ACCOUNTS
  2. | SELF
type nonrec qualifier = {
  1. cps_uri : string256;
    (*

    Contains a pointer to a certification practice statement (CPS) published by the CA.

    *)
}

Defines a PolicyInformation qualifier. Amazon Web Services Private CA supports the certification practice statement (CPS) qualifier defined in RFC 5280.

type nonrec aws_policy = string
type nonrec put_policy_request = {
  1. policy : aws_policy;
    (*

    The path and file name of a JSON-formatted IAM policy to attach to the specified private CA resource. If this policy does not contain all required statements or if it includes any statement that is not allowed, the PutPolicy action returns an InvalidPolicyException. For information about IAM policy and statement structure, see Overview of JSON Policies.

    *)
  2. resource_arn : arn;
    (*

    The Amazon Resource Number (ARN) of the private CA to associate with the policy. The ARN of the CA can be found by calling the ListCertificateAuthorities action.

    *)
}
type nonrec lockout_prevented_exception = {
  1. message : string_ option;
}

The current action was prevented because it would lock the caller out from performing subsequent actions. Verify that the specified parameters would not result in the caller being denied access to the resource.

type nonrec principal = string
type nonrec policy_qualifier_id =
  1. | CPS
type nonrec policy_qualifier_info = {
  1. qualifier : qualifier;
    (*

    Defines the qualifier type. Amazon Web Services Private CA supports the use of a URI for a CPS qualifier in this field.

    *)
  2. policy_qualifier_id : policy_qualifier_id;
    (*

    Identifies the qualifier modifying a CertPolicyId.

    *)
}

Modifies the CertPolicyId of a PolicyInformation object with a qualifier. Amazon Web Services Private CA supports the certification practice statement (CPS) qualifier.

type nonrec policy_qualifier_info_list = policy_qualifier_info list
type nonrec custom_object_identifier = string
type nonrec policy_information = {
  1. policy_qualifiers : policy_qualifier_info_list option;
    (*

    Modifies the given CertPolicyId with a qualifier. Amazon Web Services Private CA supports the certification practice statement (CPS) qualifier.

    *)
  2. cert_policy_id : custom_object_identifier;
    (*

    Specifies the object identifier (OID) of the certificate policy under which the certificate was issued. For more information, see NIST's definition of Object Identifier (OID).

    *)
}

Defines the X.509 CertificatePolicies extension.

type nonrec account_id = string
type nonrec action_type =
  1. | ListPermissions
  2. | GetCertificate
  3. | IssueCertificate
type nonrec action_list = action_type list
type nonrec permission = {
  1. policy : aws_policy option;
    (*

    The name of the policy that is associated with the permission.

    *)
  2. actions : action_list option;
    (*

    The private CA actions that can be performed by the designated Amazon Web Services service.

    *)
  3. source_account : account_id option;
    (*

    The ID of the account that assigned the permission.

    *)
  4. principal : principal option;
    (*

    The Amazon Web Services service or entity that holds the permission. At this time, the only valid principal is acm.amazonaws.com.

    *)
  5. created_at : t_stamp option;
    (*

    The time at which the permission was created.

    *)
  6. certificate_authority_arn : arn option;
    (*

    The Amazon Resource Number (ARN) of the private CA from which the permission was issued.

    *)
}

Permissions designate which private CA actions can be performed by an Amazon Web Services service or entity. In order for ACM to automatically renew private certificates, you must give the ACM service principal all available permissions (IssueCertificate, GetCertificate, and ListPermissions). Permissions can be assigned with the CreatePermission action, removed with the DeletePermission action, and listed with the ListPermissions action.

type nonrec permission_list = permission list
type nonrec permission_already_exists_exception = {
  1. message : string_ option;
}

The designated permission has already been given to the user.

type nonrec permanent_deletion_time_in_days = int
type nonrec other_name = {
  1. value : string256;
    (*

    Specifies an OID value.

    *)
  2. type_id : custom_object_identifier;
    (*

    Specifies an OID.

    *)
}

Defines a custom ASN.1 X.400 GeneralName using an object identifier (OID) and value. The OID must satisfy the regular expression shown below. For more information, see NIST's definition of Object Identifier (OID).

type nonrec next_token = string
type nonrec max_results = int
type nonrec malformed_certificate_exception = {
  1. message : string_ option;
}

One or more fields in the certificate are invalid.

type nonrec malformed_csr_exception = {
  1. message : string_ option;
}

The certificate signing request is invalid.

type nonrec list_tags_response = {
  1. tags : tag_list option;
    (*

    The tags associated with your private CA.

    *)
  2. next_token : next_token option;
    (*

    When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request.

    *)
}
type nonrec list_tags_request = {
  1. certificate_authority_arn : arn;
    (*

    The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:

    arn:aws:acm-pca:{i region}:{i account}:certificate-authority/{i 12345678-1234-1234-1234-123456789012}
    *)
  2. next_token : next_token option;
    (*

    Use this parameter when paginating results 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.

    *)
  3. max_results : max_results 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.

    *)
}
type nonrec list_permissions_response = {
  1. permissions : permission_list option;
    (*

    Summary information about each permission assigned by the specified private CA, including the action enabled, the policy provided, and the time of creation.

    *)
  2. next_token : next_token option;
    (*

    When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request.

    *)
}
type nonrec list_permissions_request = {
  1. certificate_authority_arn : arn;
    (*

    The Amazon Resource Number (ARN) of the private CA to inspect. You can find the ARN by calling the ListCertificateAuthorities action. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 You can get a private CA's ARN by running the ListCertificateAuthorities action.

    *)
  2. next_token : next_token option;
    (*

    When paginating results, use this parameter 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.

    *)
  3. max_results : max_results option;
    (*

    When paginating results, use this parameter 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.

    *)
}
type nonrec invalid_next_token_exception = {
  1. message : string_ option;
}

The token specified in the NextToken argument is not valid. Use the token returned from your previous call to ListCertificateAuthorities.

type nonrec certificate_authority_type =
  1. | SUBORDINATE
  2. | ROOT
type nonrec failure_reason =
  1. | OTHER
  2. | UNSUPPORTED_ALGORITHM
  3. | REQUEST_TIMED_OUT
type nonrec key_algorithm =
  1. | SM2
  2. | ML_DSA_87
  3. | ML_DSA_65
  4. | ML_DSA_44
  5. | EC_secp521r1
  6. | EC_secp384r1
  7. | EC_prime256v1
  8. | RSA_4096
  9. | RSA_3072
  10. | RSA_2048
type nonrec country_code_string = string
type nonrec asn1_printable_string64 = string
type nonrec custom_attribute = {
  1. value : string1_to256;
    (*

    Specifies the attribute value of relative distinguished name (RDN).

    *)
  2. object_identifier : custom_object_identifier;
    (*

    Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).

    *)
}

Defines the X.500 relative distinguished name (RDN).

type nonrec custom_attribute_list = custom_attribute list
type nonrec asn1_subject = {
  1. custom_attributes : custom_attribute_list option;
    (*

    Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of which consists of an object identifier (OID) and a value. For more information, see NIST’s definition of Object Identifier (OID).

    Custom attributes cannot be used in combination with standard attributes.

    *)
  2. generation_qualifier : string3 option;
    (*

    Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.

    *)
  3. pseudonym : string128 option;
    (*

    Typically a shortened version of a longer GivenName. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza.

    *)
  4. initials : string5 option;
    (*

    Concatenation that typically contains the first letter of the GivenName, the first letter of the middle name if one exists, and the first letter of the Surname.

    *)
  5. given_name : string16 option;
    (*

    First name.

    *)
  6. surname : string40 option;
    (*

    Family name. In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first.

    *)
  7. title : string64 option;
    (*

    A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.

    *)
  8. locality : string128 option;
    (*

    The locality (such as a city or town) in which the certificate subject is located.

    *)
  9. serial_number : asn1_printable_string64 option;
    (*

    The certificate serial number.

    *)
  10. common_name : string64 option;
    (*

    For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit.

    Note: In publicly trusted certificates, the common name must be a fully qualified domain name (FQDN) associated with the certificate subject.

    *)
  11. state : string128 option;
    (*

    State in which the subject of the certificate is located.

    *)
  12. distinguished_name_qualifier : asn1_printable_string64 option;
    (*

    Disambiguating information for the certificate subject.

    *)
  13. organizational_unit : string64 option;
    (*

    A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.

    *)
  14. organization : string64 option;
    (*

    Legal name of the organization with which the certificate subject is affiliated.

    *)
  15. country : country_code_string option;
    (*

    Two-digit code that specifies the country in which the certificate subject located.

    *)
}

Contains information about the certificate subject. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate.

type nonrec key_usage = {
  1. decipher_only : boolean_ option;
    (*

    Key can be used only to decipher data.

    *)
  2. encipher_only : boolean_ option;
    (*

    Key can be used only to encipher data.

    *)
  3. crl_sign : boolean_ option;
    (*

    Key can be used to sign CRLs.

    *)
  4. key_cert_sign : boolean_ option;
    (*

    Key can be used to sign certificates.

    *)
  5. key_agreement : boolean_ option;
    (*

    Key can be used in a key-agreement protocol.

    *)
  6. data_encipherment : boolean_ option;
    (*

    Key can be used to decipher data.

    *)
  7. key_encipherment : boolean_ option;
    (*

    Key can be used to encipher data.

    *)
  8. non_repudiation : boolean_ option;
    (*

    Key can be used for non-repudiation.

    *)
  9. digital_signature : boolean_ option;
    (*

    Key can be used for digital signing.

    *)
}

Defines one or more purposes for which the key contained in the certificate can be used. Default value for each option is false.

type nonrec access_method_type =
  1. | RESOURCE_PKI_NOTIFY
  2. | RESOURCE_PKI_MANIFEST
  3. | CA_REPOSITORY
type nonrec access_method = {
  1. access_method_type : access_method_type option;
    (*

    Specifies the AccessMethod.

    *)
  2. custom_object_identifier : custom_object_identifier option;
    (*

    An object identifier (OID) specifying the AccessMethod. The OID must satisfy the regular expression shown below. For more information, see NIST's definition of Object Identifier (OID).

    *)
}

Describes the type and format of extension access. Only one of CustomObjectIdentifier or AccessMethodType may be provided. Providing both results in InvalidArgsException.

type nonrec edi_party_name = {
  1. name_assigner : string256 option;
    (*

    Specifies the name assigner.

    *)
  2. party_name : string256;
    (*

    Specifies the party name.

    *)
}

Describes an Electronic Data Interchange (EDI) entity as described in as defined in Subject Alternative Name in RFC 5280.

type nonrec general_name = {
  1. registered_id : custom_object_identifier option;
    (*

    Represents GeneralName as an object identifier (OID).

    *)
  2. ip_address : string39 option;
    (*

    Represents GeneralName as an IPv4 or IPv6 address.

    *)
  3. uniform_resource_identifier : string253 option;
    (*

    Represents GeneralName as a URI.

    *)
  4. edi_party_name : edi_party_name option;
    (*

    Represents GeneralName as an EdiPartyName object.

    *)
  5. directory_name : asn1_subject option;
  6. dns_name : string253 option;
    (*

    Represents GeneralName as a DNS name.

    *)
  7. rfc822_name : string256 option;
    (*

    Represents GeneralName as an RFC 822 email address.

    *)
  8. other_name : other_name option;
    (*

    Represents GeneralName using an OtherName object.

    *)
}

Describes an ASN.1 X.400 GeneralName as defined in RFC 5280. Only one of the following naming options should be provided. Providing more than one option results in an InvalidArgsException error.

type nonrec access_description = {
  1. access_location : general_name;
    (*

    The location of AccessDescription information.

    *)
  2. access_method : access_method;
    (*

    The type and format of AccessDescription information.

    *)
}

Provides access information used by the authorityInfoAccess and subjectInfoAccess extensions described in RFC 5280.

type nonrec access_description_list = access_description list
type nonrec csr_extensions = {
  1. subject_information_access : access_description_list option;
    (*

    For CA certificates, provides a path to additional information pertaining to the CA, such as revocation and policy. For more information, see Subject Information Access in RFC 5280.

    *)
  2. key_usage : key_usage option;
    (*

    Indicates the purpose of the certificate and of the key contained in the certificate.

    *)
}

Describes the certificate extensions to be added to the certificate signing request (CSR).

type nonrec certificate_authority_configuration = {
  1. csr_extensions : csr_extensions option;
    (*

    Specifies information to be added to the extension section of the certificate signing request (CSR).

    *)
  2. subject : asn1_subject;
    (*

    Structure that contains X.500 distinguished name information for your private CA.

    *)
  3. signing_algorithm : signing_algorithm;
    (*

    Name of the algorithm your private CA uses to sign certificate requests.

    This parameter should not be confused with the SigningAlgorithm parameter used to sign certificates when they are issued.

    *)
  4. key_algorithm : key_algorithm;
    (*

    Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. When you create a subordinate CA, you must use a key algorithm supported by the parent CA.

    *)
}

Contains configuration information for your private certificate authority (CA). This includes information about the class of public key algorithm and the key pair that your private CA creates when it issues a certificate. It also includes the signature algorithm that it uses when issuing certificates, and its X.500 distinguished name. You must specify this information when you call the CreateCertificateAuthority action.

type nonrec key_storage_security_standard =
  1. | CCPC_LEVEL_1_OR_HIGHER
  2. | FIPS_140_2_LEVEL_3_OR_HIGHER
  3. | FIPS_140_2_LEVEL_2_OR_HIGHER
type nonrec certificate_authority_usage_mode =
  1. | SHORT_LIVED_CERTIFICATE
  2. | GENERAL_PURPOSE
type nonrec certificate_authority = {
  1. usage_mode : certificate_authority_usage_mode option;
    (*

    Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days.

    The default value is GENERAL_PURPOSE.

    *)
  2. key_storage_security_standard : key_storage_security_standard option;
    (*

    Defines a cryptographic key management compliance standard for handling and protecting CA keys.

    Default: FIPS_140_2_LEVEL_3_OR_HIGHER

    Starting January 26, 2023, Amazon Web Services Private CA protects all CA private keys in non-China regions using hardware security modules (HSMs) that comply with FIPS PUB 140-2 Level 3.

    For information about security standard support in different Amazon Web Services Regions, see Storage and security compliance of Amazon Web Services Private CA private keys.

    *)
  3. restorable_until : t_stamp option;
    (*

    The period during which a deleted CA can be restored. For more information, see the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest action.

    *)
  4. revocation_configuration : revocation_configuration option;
    (*

    Information about the Online Certificate Status Protocol (OCSP) configuration or certificate revocation list (CRL) created and maintained by your private CA.

    *)
  5. certificate_authority_configuration : certificate_authority_configuration option;
    (*

    Your private CA configuration.

    *)
  6. failure_reason : failure_reason option;
    (*

    Reason the request to create your private CA failed.

    *)
  7. not_after : t_stamp option;
    (*

    Date and time after which your private CA certificate is not valid.

    *)
  8. not_before : t_stamp option;
    (*

    Date and time before which your private CA certificate is not valid.

    *)
  9. status : certificate_authority_status option;
    (*

    Status of your private CA.

    *)
  10. serial : string_ option;
    (*

    Serial number of your private CA.

    *)
  11. type_ : certificate_authority_type option;
    (*

    Type of your private CA.

    *)
  12. last_state_change_at : t_stamp option;
    (*

    Date and time at which your private CA was last updated.

    *)
  13. created_at : t_stamp option;
    (*

    Date and time at which your private CA was created.

    *)
  14. owner_account : account_id option;
    (*

    The Amazon Web Services account ID that owns the certificate authority.

    *)
  15. arn : arn option;
    (*

    Amazon Resource Name (ARN) for your private certificate authority (CA). The format is

     {i 12345678-1234-1234-1234-123456789012}

    .

    *)
}

Contains information about your private certificate authority (CA). Your private CA can issue and revoke X.509 digital certificates. Digital certificates verify that the entity named in the certificate Subject field owns or controls the public key contained in the Subject Public Key Info field. Call the CreateCertificateAuthority action to create your private CA. You must then call the GetCertificateAuthorityCertificate action to retrieve a private CA certificate signing request (CSR). Sign the CSR with your Amazon Web Services Private CA-hosted or on-premises root or subordinate CA certificate. Call the ImportCertificateAuthorityCertificate action to import the signed certificate into Certificate Manager (ACM).

type nonrec certificate_authorities = certificate_authority list
type nonrec list_certificate_authorities_response = {
  1. certificate_authorities : certificate_authorities option;
    (*

    Summary information about each certificate authority you have created.

    *)
  2. next_token : next_token option;
    (*

    When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request.

    *)
}
type nonrec list_certificate_authorities_request = {
  1. resource_owner : resource_owner option;
    (*

    Use this parameter to filter the returned set of certificate authorities based on their owner. The default is SELF.

    *)
  2. next_token : next_token option;
    (*

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

    *)
  3. max_results : max_results option;
    (*

    Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. 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.

    Although the maximum value is 1000, the action only returns a maximum of 100 items.

    *)
}
type nonrec issue_certificate_response = {
  1. certificate_arn : arn option;
    (*

    The Amazon Resource Name (ARN) of the issued certificate and the certificate serial number. This is of the form:

    arn:aws:acm-pca:{i region}:{i account}:certificate-authority/{i 12345678-1234-1234-1234-123456789012}/certificate/{i 286535153982981100925020015808220737245}
    *)
}
type nonrec certificate_policy_list = policy_information list
type nonrec extended_key_usage_type =
  1. | CERTIFICATE_TRANSPARENCY
  2. | DOCUMENT_SIGNING
  3. | SMART_CARD_LOGIN
  4. | OCSP_SIGNING
  5. | TIME_STAMPING
  6. | EMAIL_PROTECTION
  7. | CODE_SIGNING
  8. | CLIENT_AUTH
  9. | SERVER_AUTH
type nonrec extended_key_usage = {
  1. extended_key_usage_object_identifier : custom_object_identifier option;
    (*

    Specifies a custom ExtendedKeyUsage with an object identifier (OID).

    *)
  2. extended_key_usage_type : extended_key_usage_type option;
    (*

    Specifies a standard ExtendedKeyUsage as defined as in RFC 5280.

    *)
}

Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the KeyUsage extension.

type nonrec extended_key_usage_list = extended_key_usage list
type nonrec general_name_list = general_name list
type nonrec base64_string1_to4096 = string
type nonrec custom_extension = {
  1. critical : boolean_ option;
    (*

    Specifies the critical flag of the X.509 extension.

    *)
  2. value : base64_string1_to4096;
    (*

    Specifies the base64-encoded value of the X.509 extension.

    *)
  3. object_identifier : custom_object_identifier;
    (*

    Specifies the object identifier (OID) of the X.509 extension. For more information, see the Global OID reference database.

    *)
}

Specifies the X.509 extension information for a certificate.

Extensions present in CustomExtensions follow the ApiPassthrough template rules.

type nonrec custom_extension_list = custom_extension list
type nonrec extensions = {
  1. custom_extensions : custom_extension_list option;
    (*

    Contains a sequence of one or more X.509 extensions, each of which consists of an object identifier (OID), a base64-encoded value, and the critical flag. For more information, see the Global OID reference database.

    *)
  2. subject_alternative_names : general_name_list option;
    (*

    The subject alternative name extension allows identities to be bound to the subject of the certificate. These identities may be included in addition to or in place of the identity in the subject field of the certificate.

    *)
  3. key_usage : key_usage option;
  4. extended_key_usage : extended_key_usage_list option;
    (*

    Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the KeyUsage extension.

    *)
  5. certificate_policies : certificate_policy_list option;
    (*

    Contains a sequence of one or more policy information terms, each of which consists of an object identifier (OID) and optional qualifiers. For more information, see NIST's definition of Object Identifier (OID).

    In an end-entity certificate, these terms indicate the policy under which the certificate was issued and the purposes for which it may be used. In a CA certificate, these terms limit the set of policies for certification paths that include this certificate.

    *)
}

Contains X.509 extension information for a certificate.

type nonrec api_passthrough = {
  1. subject : asn1_subject option;
  2. extensions : extensions option;
    (*

    Specifies X.509 extension information for a certificate.

    *)
}

Contains X.509 certificate information to be placed in an issued certificate. An APIPassthrough or APICSRPassthrough template variant must be selected, or else this parameter is ignored.

If conflicting or duplicate certificate information is supplied from other sources, Amazon Web Services Private CA applies order of operation rules to determine what information is used.

type nonrec csr_blob = bytes
type nonrec idempotency_token = string
type nonrec issue_certificate_request = {
  1. idempotency_token : idempotency_token option;
    (*

    Alphanumeric string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens for IssueCertificate time out after five minutes. Therefore, if you call IssueCertificate multiple times with the same idempotency token within five minutes, Amazon Web Services Private CA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, Amazon Web Services Private CA recognizes that you are requesting multiple certificates.

    *)
  2. validity_not_before : validity option;
    (*

    Information describing the start of the validity period of the certificate. This parameter sets the “Not Before" date for the certificate.

    By default, when issuing a certificate, Amazon Web Services Private CA sets the "Not Before" date to the issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The ValidityNotBefore parameter can be used to customize the “Not Before” value.

    Unlike the Validity parameter, the ValidityNotBefore parameter is optional.

    The ValidityNotBefore value is expressed as an explicit date and time, using the Validity type value ABSOLUTE. For more information, see Validity in this API reference and Validity in RFC 5280.

    *)
  3. validity : validity;
    (*

    Information describing the end of the validity period of the certificate. This parameter sets the “Not After” date for the certificate.

    Certificate validity is the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the certificate expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280.

    This value is unaffected when ValidityNotBefore is also specified. For example, if Validity is set to 20 days in the future, the certificate will expire 20 days from issuance time regardless of the ValidityNotBefore value.

    The end of the validity period configured on a certificate must not exceed the limit set on its parents in the CA hierarchy.

    *)
  4. template_arn : arn option;
    (*

    Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, Amazon Web Services Private CA defaults to the EndEntityCertificate/V1 template. For CA certificates, you should choose the shortest path length that meets your needs. The path length is indicated by the PathLenN portion of the ARN, where N is the CA depth.

    Note: The CA depth configured on a subordinate CA certificate must not exceed the limit set by its parents in the CA hierarchy.

    For a list of TemplateArn values supported by Amazon Web Services Private CA, see Understanding Certificate Templates.

    *)
  5. signing_algorithm : signing_algorithm;
    (*

    The name of the algorithm that will be used to sign the certificate to be issued.

    This parameter should not be confused with the SigningAlgorithm parameter used to sign a CSR in the CreateCertificateAuthority action.

    The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.

    *)
  6. csr : csr_blob;
    (*

    The certificate signing request (CSR) for the certificate you want to issue. As an example, you can use the following OpenSSL command to create the CSR and a 2048 bit RSA private key.

    openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr

    If you have a configuration file, you can then use the following OpenSSL command. The usr_cert block in the configuration file contains your X509 version 3 extensions.

    openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr

    Note: A CSR must provide either a subject name or a subject alternative name or the request will be rejected.

    *)
  7. certificate_authority_arn : arn;
    (*

    The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

    arn:aws:acm-pca:{i region}:{i account}:certificate-authority/{i 12345678-1234-1234-1234-123456789012}
    *)
  8. api_passthrough : api_passthrough option;
    (*

    Specifies X.509 certificate information to be included in the issued certificate. An APIPassthrough or APICSRPassthrough template variant must be selected, or else this parameter is ignored. For more information about using these templates, see Understanding Certificate Templates.

    If conflicting or duplicate certificate information is supplied during certificate issuance, Amazon Web Services Private CA applies order of operation rules to determine what information is used.

    *)
}
type nonrec certificate_body_blob = bytes
type nonrec certificate_chain_blob = bytes
type nonrec import_certificate_authority_certificate_request = {
  1. certificate_chain : certificate_chain_blob option;
    (*

    A PEM-encoded file that contains all of your certificates, other than the certificate you're importing, chaining up to your root CA. Your Amazon Web Services Private CA-hosted or on-premises root certificate is the last in the chain, and each certificate in the chain signs the one preceding.

    This parameter must be supplied when you import a subordinate CA. When you import a root CA, there is no chain.

    *)
  2. certificate : certificate_body_blob;
    (*

    The PEM-encoded certificate for a private CA. This may be a self-signed certificate in the case of a root CA, or it may be signed by another CA that you control.

    *)
  3. certificate_authority_arn : arn;
    (*

    The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

    arn:aws:acm-pca:{i region}:{i account}:certificate-authority/{i 12345678-1234-1234-1234-123456789012}
    *)
}
type nonrec certificate_mismatch_exception = {
  1. message : string_ option;
}

The certificate authority certificate you are importing does not comply with conditions specified in the certificate that signed it.

type nonrec get_policy_response = {
  1. policy : aws_policy option;
    (*

    The policy attached to the private CA as a JSON document.

    *)
}
type nonrec get_policy_request = {
  1. resource_arn : arn;
    (*

    The Amazon Resource Number (ARN) of the private CA that will have its policy retrieved. You can find the CA's ARN by calling the ListCertificateAuthorities action.

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

    The base64 PEM-encoded certificate chain that chains up to the root CA certificate that you used to sign your private CA certificate.

    *)
  2. certificate : certificate_body option;
    (*

    The base64 PEM-encoded certificate specified by the CertificateArn parameter.

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

    The ARN of the issued certificate. The ARN contains the certificate serial number and must be in the following form:

    arn:aws:acm-pca:{i region}:{i account}:certificate-authority/{i 12345678-1234-1234-1234-123456789012}/certificate/{i 286535153982981100925020015808220737245}
    *)
  2. certificate_authority_arn : arn;
    (*

    The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

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

    .

    *)
}
type nonrec csr_body = string
type nonrec get_certificate_authority_csr_response = {
  1. csr : csr_body option;
    (*

    The base64 PEM-encoded certificate signing request (CSR) for your private CA certificate.

    *)
}
type nonrec get_certificate_authority_csr_request = {
  1. certificate_authority_arn : arn;
    (*

    The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:

    arn:aws:acm-pca:{i region}:{i account}:certificate-authority/{i 12345678-1234-1234-1234-123456789012}
    *)
}
type nonrec get_certificate_authority_certificate_response = {
  1. certificate_chain : certificate_chain option;
    (*

    Base64-encoded certificate chain that includes any intermediate certificates and chains up to root certificate that you used to sign your private CA certificate. The chain does not include your private CA certificate. If this is a root CA, the value will be null.

    *)
  2. certificate : certificate_body option;
    (*

    Base64-encoded certificate authority (CA) certificate.

    *)
}
type nonrec get_certificate_authority_certificate_request = {
  1. certificate_authority_arn : arn;
    (*

    The Amazon Resource Name (ARN) of your private CA. This is of the form:

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

    .

    *)
}
type nonrec describe_certificate_authority_response = {
  1. certificate_authority : certificate_authority option;
    (*

    A CertificateAuthority structure that contains information about your private CA.

    *)
}
type nonrec describe_certificate_authority_request = {
  1. certificate_authority_arn : arn;
    (*

    The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

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

    .

    *)
}
type nonrec audit_report_status =
  1. | FAILED
  2. | SUCCESS
  3. | CREATING
type nonrec describe_certificate_authority_audit_report_response = {
  1. created_at : t_stamp option;
    (*

    The date and time at which the report was created.

    *)
  2. s3_key : s3_key option;
    (*

    S3 key that uniquely identifies the report file in your S3 bucket.

    *)
  3. s3_bucket_name : s3_bucket_name option;
    (*

    Name of the S3 bucket that contains the report.

    *)
  4. audit_report_status : audit_report_status option;
    (*

    Specifies whether report creation is in progress, has succeeded, or has failed.

    *)
}
type nonrec audit_report_id = string
type nonrec describe_certificate_authority_audit_report_request = {
  1. audit_report_id : audit_report_id;
    (*

    The report ID returned by calling the CreateCertificateAuthorityAuditReport action.

    *)
  2. certificate_authority_arn : arn;
    (*

    The Amazon Resource Name (ARN) of the private CA. This must be of the form:

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

    .

    *)
}
type nonrec delete_policy_request = {
  1. resource_arn : arn;
    (*

    The Amazon Resource Number (ARN) of the private CA that will have its policy deleted. You can find the CA's ARN by calling the ListCertificateAuthorities action. The ARN value must have the form arn:aws:acm-pca:region:account:certificate-authority/01234567-89ab-cdef-0123-0123456789ab.

    *)
}
type nonrec delete_permission_request = {
  1. source_account : account_id option;
    (*

    The Amazon Web Services account that calls this action.

    *)
  2. principal : principal;
    (*

    The Amazon Web Services service or identity that will have its CA permissions revoked. At this time, the only valid service principal is acm.amazonaws.com

    *)
  3. certificate_authority_arn : arn;
    (*

    The Amazon Resource Number (ARN) of the private CA that issued the permissions. You can find the CA's ARN by calling the ListCertificateAuthorities action. This must have the following form:

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

    .

    *)
}
type nonrec delete_certificate_authority_request = {
  1. permanent_deletion_time_in_days : permanent_deletion_time_in_days option;
    (*

    The number of days to make a CA restorable after it has been deleted. This can be anywhere from 7 to 30 days, with 30 being the default.

    *)
  2. certificate_authority_arn : arn;
    (*

    The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must have the following form:

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

    .

    *)
}
type nonrec create_permission_request = {
  1. actions : action_list;
    (*

    The actions that the specified Amazon Web Services service principal can use. These include IssueCertificate, GetCertificate, and ListPermissions.

    *)
  2. source_account : account_id option;
    (*

    The ID of the calling account.

    *)
  3. principal : principal;
    (*

    The Amazon Web Services service or identity that receives the permission. At this time, the only valid principal is acm.amazonaws.com.

    *)
  4. certificate_authority_arn : arn;
    (*

    The Amazon Resource Name (ARN) of the CA that grants the permissions. You can find the ARN by calling the ListCertificateAuthorities action. This must have the following form:

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

    .

    *)
}
type nonrec create_certificate_authority_response = {
  1. certificate_authority_arn : arn option;
    (*

    If successful, the Amazon Resource Name (ARN) of the certificate authority (CA). This is of the form:

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

    .

    *)
}
type nonrec create_certificate_authority_request = {
  1. usage_mode : certificate_authority_usage_mode option;
    (*

    Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days.

    The default value is GENERAL_PURPOSE.

    *)
  2. tags : tag_list option;
    (*

    Key-value pairs that will be attached to the new private CA. You can associate up to 50 tags with a private CA. For information using tags with IAM to manage permissions, see Controlling Access Using IAM Tags.

    *)
  3. key_storage_security_standard : key_storage_security_standard option;
    (*

    Specifies a cryptographic key management compliance standard for handling and protecting CA keys.

    Default: FIPS_140_2_LEVEL_3_OR_HIGHER

    Some Amazon Web Services Regions don't support the default value. When you create a CA in these Regions, you must use CCPC_LEVEL_1_OR_HIGHER for the KeyStorageSecurityStandard parameter. If you don't, the operation returns an InvalidArgsException with this message: "A certificate authority cannot be created in this region with the specified security standard."

    For information about security standard support in different Amazon Web Services Regions, see Storage and security compliance of Amazon Web Services Private CA private keys.

    *)
  4. idempotency_token : idempotency_token option;
    (*

    Custom string that can be used to distinguish between calls to the CreateCertificateAuthority action. Idempotency tokens for CreateCertificateAuthority time out after five minutes. Therefore, if you call CreateCertificateAuthority multiple times with the same idempotency token within five minutes, Amazon Web Services Private CA recognizes that you are requesting only certificate authority and will issue only one. If you change the idempotency token for each call, Amazon Web Services Private CA recognizes that you are requesting multiple certificate authorities.

    *)
  5. certificate_authority_type : certificate_authority_type;
    (*

    The type of the certificate authority.

    *)
  6. revocation_configuration : revocation_configuration option;
    (*

    Contains information to enable support for Online Certificate Status Protocol (OCSP), certificate revocation list (CRL), both protocols, or neither. By default, both certificate validation mechanisms are disabled.

    The following requirements apply to revocation configurations.

    • A configuration disabling CRLs or OCSP must contain only the Enabled=False parameter, and will fail if other parameters such as CustomCname or ExpirationInDays are included.
    • In a CRL configuration, the S3BucketName parameter must conform to Amazon S3 bucket naming rules.
    • A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.
    • In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as "http://" or "https://".

    For more information, see the OcspConfiguration and CrlConfiguration types.

    *)
  7. certificate_authority_configuration : certificate_authority_configuration;
    (*

    Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject information.

    *)
}
type nonrec create_certificate_authority_audit_report_response = {
  1. s3_key : s3_key option;
    (*

    The key that uniquely identifies the report file in your S3 bucket.

    *)
  2. audit_report_id : audit_report_id option;
    (*

    An alphanumeric string that contains a report identifier.

    *)
}
type nonrec audit_report_response_format =
  1. | CSV
  2. | JSON
type nonrec create_certificate_authority_audit_report_request = {
  1. audit_report_response_format : audit_report_response_format;
    (*

    The format in which to create the report. This can be either JSON or CSV.

    *)
  2. s3_bucket_name : s3_bucket_name;
    (*

    The name of the S3 bucket that will contain the audit report.

    *)
  3. certificate_authority_arn : arn;
    (*

    The Amazon Resource Name (ARN) of the CA to be audited. This is of the form:

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

    .

    *)
}