ACM / Client / list_certificate_domain_validations

list_certificate_domain_validations

ACM.Client.list_certificate_domain_validations(**kwargs)

Returns per-domain validation summaries for an ACM certificate. Each summary includes the domain name, the active validation configuration, and the requested validation configuration when a validation method migration is in progress. You can use the results to monitor the progress of an email-to-DNS validation migration and to retrieve the CNAME records required for DNS validation.

See also: AWS API Documentation

Request Syntax

response = client.list_certificate_domain_validations(
    CertificateArn='string',
    NextToken='string',
    MaxItems=123
)
Parameters:

  • CertificateArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the certificate for which to list domain validation summaries.

  • NextToken (string) – A token returned by a previous call to ListCertificateDomainValidations. If the number of results exceeds MaxItems, use this token to retrieve the next page of results.

  • MaxItems (integer) – The maximum number of domain validation summaries to return. If you don’t specify a value, the default is 1000.

Return type:

dict

Returns:

Response Syntax

{
    'DomainValidationSummaryList': [
        {
            'DomainName': 'string',
            'ActiveValidationConfiguration': {
                'ValidationMethod': 'EMAIL'|'DNS'|'HTTP',
                'ValidationChallenge': {
                    'EmailValidationChallenge': {
                        'ValidationEmails': [
                            'string',
                        ],
                        'ValidationDomain': 'string'
                    },
                    'DnsValidationChallenge': {
                        'ResourceRecord': {
                            'Name': 'string',
                            'Type': 'CNAME',
                            'Value': 'string'
                        }
                    }
                },
                'ValidationStatus': 'PENDING_VALIDATION'|'SUCCESS'|'FAILED'
            },
            'RequestedValidationConfiguration': {
                'ValidationMethod': 'EMAIL'|'DNS'|'HTTP',
                'ValidationChallenge': {
                    'EmailValidationChallenge': {
                        'ValidationEmails': [
                            'string',
                        ],
                        'ValidationDomain': 'string'
                    },
                    'DnsValidationChallenge': {
                        'ResourceRecord': {
                            'Name': 'string',
                            'Type': 'CNAME',
                            'Value': 'string'
                        }
                    }
                },
                'ValidationStatus': 'PENDING_VALIDATION'|'SUCCESS'|'FAILED'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • DomainValidationSummaryList (list) –

      A list of DomainValidationSummary objects, one for each domain on the certificate. Each object contains the domain name and its active and requested validation configurations.

      • (dict) –

        Contains per-domain validation information for a certificate. This structure is returned as a member of the ListCertificateDomainValidations response.

        • DomainName (string) –

          The fully qualified domain name (FQDN) in the certificate for which this validation summary applies.

        • ActiveValidationConfiguration (dict) –

          The validation configuration currently in effect for this domain. This reflects the validation method that ACM is currently using to validate domain ownership (for example, email or DNS).

          • ValidationMethod (string) –

            The validation method for this configuration. Valid values:

            • DNS – Validation using a CNAME record added to your DNS configuration.

            • EMAIL – Validation using an approval email sent to domain contacts.

            • HTTP – Validation using an HTTP resource placed on your web server.

          • ValidationChallenge (dict) –

            The validation challenge details for this configuration. The structure varies by validation method: for DNS validation, contains a DnsValidationChallenge with the CNAME record to add; for email validation, contains an EmailValidationChallenge with the validation email addresses.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: EmailValidationChallenge, DnsValidationChallenge. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

            • EmailValidationChallenge (dict) –

              Contains the email addresses used for email-based domain validation.

              • ValidationEmails (list) –

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

                • (string) –

              • ValidationDomain (string) –

                The domain name that ACM uses to send validation emails.

            • DnsValidationChallenge (dict) –

              Contains the CNAME record that you must add to your DNS configuration to validate domain ownership using DNS validation.

              • ResourceRecord (dict) –

                The CNAME record that ACM creates for DNS validation. Add this record to your DNS configuration to prove that you own or control the domain.

                • Name (string) –

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

                • Type (string) –

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

                • Value (string) –

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

          • ValidationStatus (string) –

            The validation status for this domain. Valid values:

            • PENDING_VALIDATION – The domain is waiting for validation to complete.

            • SUCCESS – Validation completed successfully.

            • FAILED – Validation failed.

        • RequestedValidationConfiguration (dict) –

          The validation configuration for a pending validation method migration. This field is present only when a migration is in progress (for example, from email to DNS validation). It contains the target validation method, the current validation status, and the validation challenge details (such as the CNAME record to add to your DNS configuration).

          • ValidationMethod (string) –

            The validation method for this configuration. Valid values:

            • DNS – Validation using a CNAME record added to your DNS configuration.

            • EMAIL – Validation using an approval email sent to domain contacts.

            • HTTP – Validation using an HTTP resource placed on your web server.

          • ValidationChallenge (dict) –

            The validation challenge details for this configuration. The structure varies by validation method: for DNS validation, contains a DnsValidationChallenge with the CNAME record to add; for email validation, contains an EmailValidationChallenge with the validation email addresses.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: EmailValidationChallenge, DnsValidationChallenge. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

            • EmailValidationChallenge (dict) –

              Contains the email addresses used for email-based domain validation.

              • ValidationEmails (list) –

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

                • (string) –

              • ValidationDomain (string) –

                The domain name that ACM uses to send validation emails.

            • DnsValidationChallenge (dict) –

              Contains the CNAME record that you must add to your DNS configuration to validate domain ownership using DNS validation.

              • ResourceRecord (dict) –

                The CNAME record that ACM creates for DNS validation. Add this record to your DNS configuration to prove that you own or control the domain.

                • Name (string) –

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

                • Type (string) –

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

                • Value (string) –

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

          • ValidationStatus (string) –

            The validation status for this domain. Valid values:

            • PENDING_VALIDATION – The domain is waiting for validation to complete.

            • SUCCESS – Validation completed successfully.

            • FAILED – Validation failed.

    • NextToken (string) –

      If the number of results exceeds MaxItems, this token is included in the response. Use this token in a subsequent ListCertificateDomainValidations request to retrieve the next page of results.

Exceptions

  • ACM.Client.exceptions.InvalidArgsException

  • ACM.Client.exceptions.AccessDeniedException

  • ACM.Client.exceptions.ResourceNotFoundException

  • ACM.Client.exceptions.ThrottlingException