Skip to content

ACM  >  Operations  >  list_certificate_domain_validations

list_certificate_domain_validations

Operation

list_certificate_domain_validations async

list_certificate_domain_validations(request: ListCertificateDomainValidationsInput | ListCertificateDomainValidationsInputDict, /, *, plugins: list[Plugin] | None = None) -> ListCertificateDomainValidationsOutput
list_certificate_domain_validations(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListCertificateDomainValidationsInputDict]) -> ListCertificateDomainValidationsOutput

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.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
ListCertificateDomainValidationsOutput

An instance of ListCertificateDomainValidationsOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

ListCertificateDomainValidationsInput dataclass

Bases: _SerdeShape

Dataclass for ListCertificateDomainValidationsInput structure.

Attributes
certificate_arn class-attribute instance-attribute
certificate_arn: str | None = ...

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

max_items class-attribute instance-attribute
max_items: int | None = ...

The maximum number of domain validation summaries to return. If you don't specify a value, the default is 1000.

next_token class-attribute instance-attribute
next_token: str | None = ...

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.

Dictionaries

ListCertificateDomainValidationsInputDict

Bases: TypedDict

Dictionary form of ListCertificateDomainValidationsInput.

Attributes
certificate_arn instance-attribute
certificate_arn: Required[str]

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

max_items instance-attribute
max_items: int | None

The maximum number of domain validation summaries to return. If you don't specify a value, the default is 1000.

next_token instance-attribute
next_token: str | None

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.

Output

ListCertificateDomainValidationsOutput dataclass

Bases: _SerdeShape

Dataclass for ListCertificateDomainValidationsOutput structure.

Attributes

domain_validation_summary_list class-attribute instance-attribute
domain_validation_summary_list: list[DomainValidationSummary] | None = ...

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.

next_token class-attribute instance-attribute
next_token: str | None = ...

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.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.