ACM / Client / create_acme_domain_validation

create_acme_domain_validation

ACM.Client.create_acme_domain_validation(**kwargs)

Creates a domain validation for an ACME endpoint. Domain validations authorize the endpoint to issue certificates for specified domain names. You configure prevalidation to prove domain ownership.

See also: AWS API Documentation

Request Syntax

response = client.create_acme_domain_validation(
    IdempotencyToken='string',
    AcmeEndpointArn='string',
    DomainName='string',
    PrevalidationOptions={
        'DnsPrevalidation': {
            'DomainScope': {
                'ExactDomain': 'ENABLED'|'DISABLED',
                'Subdomains': 'ENABLED'|'DISABLED',
                'Wildcards': 'ENABLED'|'DISABLED'
            },
            'HostedZoneId': 'string'
        }
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • IdempotencyToken (string) –

    A unique, case-sensitive identifier to ensure idempotency of the request.

    This field is autopopulated if not provided.

  • AcmeEndpointArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the ACME endpoint.

  • DomainName (string) –

    [REQUIRED]

    The domain name to validate.

  • PrevalidationOptions (dict) –

    [REQUIRED]

    The prevalidation options for the domain.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: DnsPrevalidation.

    • DnsPrevalidation (dict) –

      DNS-based prevalidation options.

      • DomainScope (dict) –

        The scope of domains covered by this prevalidation.

        • ExactDomain (string) –

          Whether validation applies to the exact domain.

        • Subdomains (string) –

          Whether validation applies to subdomains.

        • Wildcards (string) –

          Whether validation applies to wildcard domains.

      • HostedZoneId (string) –

        The Route 53 hosted zone ID for DNS validation.

  • Tags (list) –

    One or more tags to associate with the domain validation.

    • (dict) –

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

      • Key (string) – [REQUIRED]

        The key of the tag.

      • Value (string) –

        The value of the tag.

Return type:

dict

Returns:

Response Syntax

{
    'AcmeDomainValidationArn': 'string'
}

Response Structure

  • (dict) –

    • AcmeDomainValidationArn (string) –

      The Amazon Resource Name (ARN) of the created domain validation.

Exceptions

  • ACM.Client.exceptions.InternalServerException

  • ACM.Client.exceptions.ServiceQuotaExceededException

  • ACM.Client.exceptions.ConflictException

  • ACM.Client.exceptions.AccessDeniedException

  • ACM.Client.exceptions.ValidationException

  • ACM.Client.exceptions.ResourceNotFoundException

  • ACM.Client.exceptions.ThrottlingException