request_certificate async ¶

async def request_certificate(
    self,
    domain_name: "capo_acm.types.domain_name_string.DomainNameString",
    *,
    config_overrides: Optional[AsyncACMClientConfig] = None,
    validation_method: Optional[
        "capo_acm.types.validation_method.ValidationMethod"
    ] = None,
    subject_alternative_names: Optional[
        "capo_acm.types.domain_list.DomainList"
    ] = None,
    idempotency_token: Optional[
        "capo_acm.types.idempotency_token.IdempotencyToken"
    ] = None,
    domain_validation_options: Optional[
        "capo_acm.types.domain_validation_option_list.DomainValidationOptionList"
    ] = None,
    options: Optional[
        "capo_acm.types.certificate_options.CertificateOptions"
    ] = None,
    certificate_authority_arn: Optional["capo_acm.types.pca_arn.PcaArn"] = None,
    tags: Optional["capo_acm.types.tag_list.TagList"] = None,
    key_algorithm: Optional["capo_acm.types.key_algorithm.KeyAlgorithm"] = None,
    managed_by: Optional[
        "capo_acm.types.certificate_managed_by.CertificateManagedBy"
    ] = None,
) -> "capo_acm.types.request_certificate_response.RequestCertificateResponse":
    """<p>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 <code>DomainName</code> parameter. You can also specify additional FQDNs in the <code>SubjectAlternativeNames</code> parameter. </p> <p>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 <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html">DNS validation</a> or <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html">email validation</a>. We recommend that you use DNS validation.</p> <note> <p>ACM behavior differs from the <a href="https://datatracker.ietf.org/doc/html/rfc6125#appendix-B.2">RFC 6125</a> specification of the certificate validation process. ACM first checks for a Subject Alternative Name, and, if it finds one, ignores the common name (CN).</p> </note> <p>After successful completion of the <code>RequestCertificate</code> action, there is a delay of several seconds before you can retrieve information about the new certificate.</p>

    Args:
        domain_name: <p>Fully qualified domain name (FQDN), such as www.example.com, that you want to secure with an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com. </p> <p>In compliance with <a href="https://datatracker.ietf.org/doc/html/rfc5280">RFC 5280</a>, the length of the domain name (technically, the Common Name) that you provide cannot exceed 64 octets (characters), including periods. To add a longer domain name, specify it in the Subject Alternative Name field, which supports names up to 253 octets in length. </p>
        validation_method: <p>The method you want to use if you are requesting a public certificate to validate that you own or control domain. You can <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html">validate with DNS</a> or <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html">validate with email</a>. We recommend that you use DNS validation. </p>
        subject_alternative_names: <p>Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, add the name www.example.net to a certificate for which the <code>DomainName</code> field is www.example.com if users can reach your site by using either name. The maximum number of domain names that you can add to an ACM certificate is 100. However, the initial quota is 10 domain names. If you need more than 10 names, you must request a quota increase. For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html">Quotas</a>.</p> <p> The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples: </p> <ul> <li> <p> <code>(63 octets).(63 octets).(63 octets).(61 octets)</code> is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets.</p> </li> <li> <p> <code>(64 octets).(63 octets).(63 octets).(61 octets)</code> is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets.</p> </li> <li> <p> <code>(63 octets).(63 octets).(63 octets).(62 octets)</code> is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.</p> </li> </ul>
        idempotency_token: <p>Customer chosen string that can be used to distinguish between calls to <code>RequestCertificate</code>. Idempotency tokens time out after one hour. Therefore, if you call <code>RequestCertificate</code> multiple times with the same idempotency token within one hour, ACM recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, ACM recognizes that you are requesting multiple certificates.</p>
        domain_validation_options: <p>The domain name that you want ACM to use to send you emails so that you can validate domain ownership.</p>
        options: <p>You can use this parameter to specify whether to export your certificate.</p> <p>Certificate transparency logging opt-out is no longer available. All public certificates are recorded in a certificate transparency log. For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-concepts.html#concept-transparency">Certificate Transparency Logging</a>.</p> <p>You can export public ACM certificates to use with Amazon Web Services services as well as outside the Amazon Web Services Cloud. For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-exportable-certificates.html">Certificate Manager exportable public certificate</a>.</p>
        certificate_authority_arn: <p>The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate. For more information about private CAs, see the <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaWelcome.html">Amazon Web Services Private Certificate Authority</a> user guide. The ARN must have the following form: </p> <p> <code>arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012</code> </p>
        tags: <p>One or more resource tags to associate with the certificate.</p>
        key_algorithm: <p>Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data. RSA is the default key algorithm for ACM certificates. Elliptic Curve Digital Signature Algorithm (ECDSA) keys are smaller, offering security comparable to RSA keys but with greater computing efficiency. However, ECDSA is not supported by all network clients. Some Amazon Web Services services may require RSA keys, or only support ECDSA keys of a particular size, while others allow the use of either RSA and ECDSA keys to ensure that compatibility is not broken. Check the requirements for the Amazon Web Services service where you plan to deploy your certificate. For more information about selecting an algorithm, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-certificate-characteristics.html#algorithms-term">Key algorithms</a>.</p> <note> <p>Algorithms supported for an ACM certificate request include: </p> <ul> <li> <p> <code>RSA_2048</code> </p> </li> <li> <p> <code>EC_prime256v1</code> </p> </li> <li> <p> <code>EC_secp384r1</code> </p> </li> </ul> <p>Other listed algorithms are for imported certificates only. </p> </note> <note> <p>When you request a private PKI certificate signed by a CA from Amazon Web Services Private CA, the specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.</p> </note> <p>Default: RSA_2048</p>
        managed_by: <p>Identifies the Amazon Web Services service that manages the certificate issued by ACM.</p>

    Raises:
        capo_acm.errors.invalid_arn_exception.InvalidArnException: <p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>
        capo_acm.errors.invalid_domain_validation_options_exception.InvalidDomainValidationOptionsException: <p>One or more values in the <a>DomainValidationOption</a> structure is incorrect.</p>
        capo_acm.errors.invalid_parameter_exception.InvalidParameterException: <p>An input parameter was invalid.</p>
        capo_acm.errors.invalid_tag_exception.InvalidTagException: <p>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 <code>aws:</code>.</p>
        capo_acm.errors.limit_exceeded_exception.LimitExceededException: <p>An ACM quota has been exceeded.</p>
        capo_acm.errors.tag_policy_exception.TagPolicyException: <p>A specified tag did not comply with an existing tag policy and was rejected.</p>
        capo_acm.errors.too_many_tags_exception.TooManyTagsException: <p>The request contains too many tags. Try the request again with fewer tags.</p>
        capo_acm.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_acm.types.request_certificate_request.RequestCertificateRequest]",
    ) -> AsyncOperationResponse[
        "capo_acm.types.request_certificate_response.RequestCertificateResponse"
    ]:
        import capo_acm._operations.certificate_manager.request_certificate

        (
            output,
            http_response,
        ) = await capo_acm._operations.certificate_manager.request_certificate.async_request_certificate(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("RequestCertificate")
    )
    input_: capo_acm.types.request_certificate_request.RequestCertificateRequest = {
        "domain_name": domain_name
    }
    if validation_method is not None:
        input_["validation_method"] = validation_method
    if subject_alternative_names is not None:
        input_["subject_alternative_names"] = subject_alternative_names
    if idempotency_token is not None:
        input_["idempotency_token"] = idempotency_token
    if domain_validation_options is not None:
        input_["domain_validation_options"] = domain_validation_options
    if options is not None:
        input_["options"] = options
    if certificate_authority_arn is not None:
        input_["certificate_authority_arn"] = certificate_authority_arn
    if tags is not None:
        input_["tags"] = tags
    if key_algorithm is not None:
        input_["key_algorithm"] = key_algorithm
    if managed_by is not None:
        input_["managed_by"] = managed_by

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output