Module Awso_acm.ValuesSource

Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval serviceAbbreviation : string
Sourceval targetPrefix : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule ServiceErrorMessage : sig ... end
Sourcemodule AccessDeniedException : sig ... end

You do not have access required to perform this action.

Sourcemodule ValidationMethod : sig ... end
Sourcemodule TStamp : sig ... end
Sourcemodule RenewalStatus : sig ... end
Sourcemodule RenewalEligibility : sig ... end
Sourcemodule NullableBoolean : sig ... end
Sourcemodule CertificateType : sig ... end
Sourcemodule CertificateStatus : sig ... end
Sourcemodule CertificateManagedBy : sig ... end
Sourcemodule CertificateExport : sig ... end
Sourcemodule AcmCertificateMetadata : sig ... end

Contains ACM-specific metadata about a certificate.

Filters certificates by ACM metadata.

Sourcemodule TagValue : sig ... end
Sourcemodule TagKey : sig ... end
Sourcemodule Tag : sig ... end

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

Sourcemodule TagList : sig ... end
Sourcemodule Arn : sig ... end

Adds one or more tags to an ACM certificate. Tags are labels that you can use to identify and organize your Amazon Web Services resources. Each tag consists of a key and an optional value. You specify the certificate on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see Tagging ACM certificates. To remove one or more tags, use the RemoveTagsFromCertificate action. To view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action.

Sourcemodule AvailabilityErrorMessage : sig ... end
Sourcemodule CertificateBody : sig ... end
Sourcemodule CertificateBodyBlob : sig ... end
Sourcemodule CertificateChain : sig ... end
Sourcemodule CertificateChainBlob : sig ... end
Sourcemodule String_ : sig ... end
Sourcemodule RevocationReason : sig ... end
Sourcemodule FailureReason : sig ... end
Sourcemodule ValidationEmailList : sig ... end
Sourcemodule RecordType : sig ... end
Sourcemodule ResourceRecord : sig ... end

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

Sourcemodule HttpRedirect : sig ... end

Contains information for HTTP-based domain validation of certificates requested through Amazon CloudFront and issued by ACM. This field exists only when the certificate type is AMAZON_ISSUED and the validation method is HTTP.

Sourcemodule DomainStatus : sig ... end
Sourcemodule DomainNameString : sig ... end
Sourcemodule DomainValidation : sig ... end

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

Sourcemodule DomainValidationList : sig ... end
Sourcemodule RenewalSummary : sig ... end

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

Sourcemodule KeyUsageName : sig ... end
Sourcemodule KeyUsage : sig ... end

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

Sourcemodule KeyUsageList : sig ... end
Sourcemodule KeyAlgorithm : sig ... end
Sourcemodule InUseList : sig ... end
Sourcemodule ExtendedKeyUsageName : sig ... end
Sourcemodule ExtendedKeyUsage : sig ... end

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.

Sourcemodule ExtendedKeyUsageList : sig ... end
Sourcemodule DomainList : sig ... end
Sourcemodule CertificateOptions : sig ... end

Structure that contains options for your certificate. You can use this structure to specify whether to opt in to or out of certificate transparency logging and export your certificate. 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. You can export public ACM certificates to use with Amazon Web Services services as well as outside Amazon Web Services Cloud. For more information, see Certificate Manager exportable public certificate.

Sourcemodule CertificateDetail : sig ... end

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

Sourcemodule TimestampRange : sig ... end

Specifies a time range for filtering certificates.

Sourcemodule FilterString : sig ... end
Sourcemodule ComparisonOperator : sig ... end
Sourcemodule CommonNameFilter : sig ... end

Filters certificates by common name.

Sourcemodule SubjectFilter : sig ... end

Filters certificates by subject attributes.

Sourcemodule DnsNameFilter : sig ... end

Filters certificates by DNS name.

Filters certificates by subject alternative name attributes.

Sourcemodule SerialNumber : sig ... end
Sourcemodule X509AttributeFilter : sig ... end

Filters certificates by X.509 attributes.

Sourcemodule CertificateFilter : sig ... end

Defines a filter for searching certificates by ARN, X.509 attributes, or ACM metadata.

module CertificateFilterStatement : sig ... end

A filter statement used to search for certificates. Can contain AND, OR, NOT logical operators or a single filter.

module CertificateFilterStatementList : sig ... end
Sourcemodule CertificateMetadata : sig ... end

Contains metadata about a certificate. Currently supports ACM certificate metadata.

Sourcemodule KeyUsageNames : sig ... end
Sourcemodule OtherName : sig ... end

Defines a custom ASN.1 X.400 GeneralName using an object identifier (OID) and value. For more information, see NIST's definition of Object Identifier (OID).

Sourcemodule DomainComponentList : sig ... end
Sourcemodule CustomAttribute : sig ... end

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

Sourcemodule CustomAttributeList : sig ... end
Sourcemodule DistinguishedName : sig ... end

Contains X.500 distinguished name information.

Sourcemodule GeneralName : sig ... end

Describes an ASN.1 X.400 GeneralName as defined in RFC 5280. Only one of the following naming options should be provided.

Sourcemodule GeneralNameList : sig ... end
Sourcemodule ExtendedKeyUsageNames : sig ... end
Sourcemodule X509Attributes : sig ... end

Contains X.509 certificate attributes extracted from the certificate.

Sourcemodule CertificateSearchResult : sig ... end

Contains information about a certificate returned by the SearchCertificates action. This structure includes the certificate ARN, X.509 attributes, and ACM metadata.

Sourcemodule CertificateStatuses : sig ... end
Sourcemodule CertificateSummary : sig ... end

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

Sourcemodule CertificateSummaryList : sig ... end
Sourcemodule ConflictException : sig ... end

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.

Sourcemodule DeleteCertificateRequest : sig ... end

Deletes a certificate and its associated private key. If this action succeeds, the certificate is not available for use by Amazon Web Services services integrated with ACM. Deleting a certificate is eventually consistent. The may be a short delay before the certificate no longer appears in the list that can be displayed by calling the ListCertificates action or be retrieved by calling the GetCertificate action. You cannot delete an ACM certificate that is being used by another Amazon Web Services service. To delete a certificate that is in use, you must first remove the certificate association using the console or the CLI for the associated service. Deleting a certificate issued by a private certificate authority (CA) has no effect on the CA. You will continue to be charged for the CA until it is deleted. For more information, see Deleting Your Private CA in the Private Certificate Authority User Guide. Deleting a certificate issued by a private certificate authority (CA) has no effect on the CA. You will continue to be charged for the CA until it is deleted. For more information, see Deleting your private CA in the Amazon Web Services Private Certificate Authority User Guide.

Returns detailed metadata about the specified ACM certificate. If you have just created a certificate using the RequestCertificate action, there is a delay of several seconds before you can retrieve information about it.

Sourcemodule ResourceNotFoundException : sig ... end

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

Sourcemodule InvalidArnException : sig ... end

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

Returns detailed metadata about the specified ACM certificate. If you have just created a certificate using the RequestCertificate action, there is a delay of several seconds before you can retrieve information about it.

Sourcemodule DomainValidationOption : sig ... end

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

Sourcemodule PositiveInteger : sig ... end
Sourcemodule ExpiryEventsConfiguration : sig ... end

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

Sourcemodule PassphraseBlob : sig ... end
Sourcemodule ExportCertificateRequest : sig ... end

Exports a private certificate issued by a private certificate authority (CA) or a public certificate for use anywhere. The exported file contains the certificate, the certificate chain, and the encrypted private key associated with the public key that is embedded in the certificate. For security, you must assign a passphrase for the private key when exporting it. For information about exporting and formatting a certificate using the ACM console or CLI, see Export a private certificate and Export a public certificate. ACM public certificates created prior to June 17, 2025 cannot be exported.

Sourcemodule ThrottlingReason : sig ... end

A description of why a request was throttled.

Sourcemodule ThrottlingReasonList : sig ... end
Sourcemodule ThrottlingException : sig ... end

The request was denied because it exceeded a quota.

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

Sourcemodule PrivateKey : sig ... end
Sourcemodule ExportCertificateResponse : sig ... end

Exports a private certificate issued by a private certificate authority (CA) or a public certificate for use anywhere. The exported file contains the certificate, the certificate chain, and the encrypted private key associated with the public key that is embedded in the certificate. For security, you must assign a passphrase for the private key when exporting it. For information about exporting and formatting a certificate using the ACM console or CLI, see Export a private certificate and Export a public certificate. ACM public certificates created prior to June 17, 2025 cannot be exported.

Sourcemodule KeyUsageFilterList : sig ... end
Sourcemodule KeyAlgorithmList : sig ... end
Sourcemodule Filters : sig ... end

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

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

Sourcemodule GetCertificateRequest : sig ... end

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

Sourcemodule GetCertificateResponse : sig ... end

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

Sourcemodule IdempotencyToken : sig ... end
Sourcemodule PrivateKeyBlob : sig ... end
Sourcemodule ImportCertificateRequest : sig ... end

Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with ACM. Note that integrated services allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see Importing Certificates in the Certificate Manager User Guide. ACM does not provide managed renewal for certificates that you import. Note the following guidelines when importing third party certificates: You must enter the private key that matches the certificate you are importing. The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase. The private key must be no larger than 5 KB (5,120 bytes). The certificate, private key, and certificate chain must be PEM-encoded. The current time must be between the Not Before and Not After certificate fields. The Issuer field must not be empty. The OCSP authority URL, if present, must not exceed 1000 characters. To import a new certificate, omit the CertificateArn argument. Include this argument only when you want to replace a previously imported certificate. When you import a certificate by using the CLI, you must specify the certificate, the certificate chain, and the private key by their file names preceded by fileb://. For example, you can specify a certificate saved in the C:\temp folder as fileb://C:\temp\certificate_to_import.pem. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs. When you import a certificate by using an SDK, you must specify the certificate, the certificate chain, and the private key files in the manner required by the programming language you're using. The cryptographic algorithm of an imported certificate must match the algorithm of the signing CA. For example, if the signing CA key type is RSA, then the certificate key type must also be RSA. This operation returns the Amazon Resource Name (ARN) of the imported certificate.

Sourcemodule TooManyTagsException : sig ... end

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

Sourcemodule TagPolicyException : sig ... end

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

Sourcemodule LimitExceededException : sig ... end

An ACM quota has been exceeded.

Sourcemodule InvalidTagException : sig ... end

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:.

Sourcemodule InvalidParameterException : sig ... end

An input parameter was invalid.

Sourcemodule ImportCertificateResponse : sig ... end

Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with ACM. Note that integrated services allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see Importing Certificates in the Certificate Manager User Guide. ACM does not provide managed renewal for certificates that you import. Note the following guidelines when importing third party certificates: You must enter the private key that matches the certificate you are importing. The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase. The private key must be no larger than 5 KB (5,120 bytes). The certificate, private key, and certificate chain must be PEM-encoded. The current time must be between the Not Before and Not After certificate fields. The Issuer field must not be empty. The OCSP authority URL, if present, must not exceed 1000 characters. To import a new certificate, omit the CertificateArn argument. Include this argument only when you want to replace a previously imported certificate. When you import a certificate by using the CLI, you must specify the certificate, the certificate chain, and the private key by their file names preceded by fileb://. For example, you can specify a certificate saved in the C:\temp folder as fileb://C:\temp\certificate_to_import.pem. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs. When you import a certificate by using an SDK, you must specify the certificate, the certificate chain, and the private key files in the manner required by the programming language you're using. The cryptographic algorithm of an imported certificate must match the algorithm of the signing CA. For example, if the signing CA key type is RSA, then the certificate key type must also be RSA. This operation returns the Amazon Resource Name (ARN) of the imported certificate.

Sourcemodule InvalidArgsException : sig ... end

One or more of request parameters specified is not valid.

One or more values in the DomainValidationOption structure is incorrect.

Sourcemodule InvalidStateException : sig ... end

Processing has reached an invalid state.

Sourcemodule SortOrder : sig ... end
Sourcemodule SortBy : sig ... end
Sourcemodule NextToken : sig ... end
Sourcemodule MaxItems : sig ... end
Sourcemodule ListCertificatesRequest : sig ... end

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

Sourcemodule ValidationException : sig ... end

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

Sourcemodule ListCertificatesResponse : sig ... end

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

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

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

Sourcemodule PcaArn : sig ... end

Adds or modifies account-level configurations in ACM. The supported configuration option is DaysBeforeExpiry. This 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.

Remove one or more tags from an ACM certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. To add tags to a certificate, use the AddTagsToCertificate action. To view all of the tags that have been applied to a specific ACM certificate, use the ListTagsForCertificate action.

Sourcemodule RenewCertificateRequest : sig ... end

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

Sourcemodule RequestCertificateRequest : sig ... end

Requests an ACM certificate for use with other Amazon Web Services services. To request an ACM certificate, you must specify a fully qualified domain name (FQDN) in the DomainName parameter. You can also specify additional FQDNs in the SubjectAlternativeNames parameter. If you are requesting a private certificate, domain validation is not required. If you are requesting a public certificate, each domain name that you specify must be validated to verify that you own or control the domain. You can use DNS validation or email validation. We recommend that you use DNS validation. ACM behavior differs from the RFC 6125 specification of the certificate validation process. ACM first checks for a Subject Alternative Name, and, if it finds one, ignores the common name (CN). After successful completion of the RequestCertificate action, there is a delay of several seconds before you can retrieve information about the new certificate.

Requests an ACM certificate for use with other Amazon Web Services services. To request an ACM certificate, you must specify a fully qualified domain name (FQDN) in the DomainName parameter. You can also specify additional FQDNs in the SubjectAlternativeNames parameter. If you are requesting a private certificate, domain validation is not required. If you are requesting a public certificate, each domain name that you specify must be validated to verify that you own or control the domain. You can use DNS validation or email validation. We recommend that you use DNS validation. ACM behavior differs from the RFC 6125 specification of the certificate validation process. ACM first checks for a Subject Alternative Name, and, if it finds one, ignores the common name (CN). After successful completion of the RequestCertificate action, there is a delay of several seconds before you can retrieve information about the new certificate.

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

Sourcemodule ResourceInUseException : sig ... end

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

Sourcemodule RevokeCertificateRequest : sig ... end

Revokes a public ACM certificate. You can only revoke certificates that have been previously exported. Once a certificate is revoked, you cannot reuse the certificate. Revoking a certificate is permanent.

Sourcemodule RevokeCertificateResponse : sig ... end

Revokes a public ACM certificate. You can only revoke certificates that have been previously exported. Once a certificate is revoked, you cannot reuse the certificate. Revoking a certificate is permanent.

Sourcemodule SearchMaxResults : sig ... end
Sourcemodule SearchCertificatesSortBy : sig ... end
Sourcemodule SearchCertificatesRequest : sig ... end

Retrieves a list of certificates matching search criteria. You can filter certificates by X.509 attributes and ACM specific properties like certificate status, type and renewal eligibility. This operation provides more flexible filtering than ListCertificates by supporting complex filter statements.

Retrieves a list of certificates matching search criteria. You can filter certificates by X.509 attributes and ACM specific properties like certificate status, type and renewal eligibility. This operation provides more flexible filtering than ListCertificates by supporting complex filter statements.

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