Skip to content

ACM  >  Operations  >  list_certificates

list_certificates

Operation

list_certificates async

list_certificates(request: ListCertificatesInput | ListCertificatesInputDict, /, *, plugins: list[Plugin] | None = None) -> ListCertificatesOutput
list_certificates(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListCertificatesInputDict]) -> ListCertificatesOutput

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.

Note

By default, this action does not return certificates with a CertificateKeyPairOrigin of ACME. To include ACME certificates, specify ACME in the CertificateKeyPairOrigins filter.

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
ListCertificatesOutput

An instance of ListCertificatesOutput.

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

ListCertificatesInput dataclass

Bases: _SerdeShape

Dataclass for ListCertificatesInput structure.

Attributes
certificate_key_pair_origins class-attribute instance-attribute
certificate_key_pair_origins: list[str] | None = ...

Filter the certificate list by certificate key pair origin. Specify one or more CertificateKeyPairOrigin values. Default filtering returns only certificates with key pair origin of AWS_MANAGED and CUSTOMER_PROVIDED.

certificate_statuses class-attribute instance-attribute
certificate_statuses: list[str] | None = ...

Filter the certificate list by status value.

includes class-attribute instance-attribute
includes: Filters | None = ...

Filter the certificate list. For more information, see the Filters structure.

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

Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.

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

Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received.

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

Specifies the field to sort results by. If you specify SortBy, you must also specify SortOrder.

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

Specifies the order of sorted results. If you specify SortOrder, you must also specify SortBy.

Dictionaries

ListCertificatesInputDict

Bases: TypedDict

Dictionary form of ListCertificatesInput.

Attributes
certificate_key_pair_origins instance-attribute
certificate_key_pair_origins: Sequence[str] | None

Filter the certificate list by certificate key pair origin. Specify one or more CertificateKeyPairOrigin values. Default filtering returns only certificates with key pair origin of AWS_MANAGED and CUSTOMER_PROVIDED.

certificate_statuses instance-attribute
certificate_statuses: Sequence[str] | None

Filter the certificate list by status value.

includes instance-attribute
includes: Filters | FiltersDict | None

Filter the certificate list. For more information, see the Filters structure.

max_items instance-attribute
max_items: int | None

Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.

next_token instance-attribute
next_token: str | None

Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received.

sort_by instance-attribute
sort_by: str | None

Specifies the field to sort results by. If you specify SortBy, you must also specify SortOrder.

sort_order instance-attribute
sort_order: str | None

Specifies the order of sorted results. If you specify SortOrder, you must also specify SortBy.

Output

ListCertificatesOutput dataclass

Bases: _SerdeShape

Dataclass for ListCertificatesOutput structure.

Attributes

certificate_summary_list class-attribute instance-attribute
certificate_summary_list: list[CertificateSummary] | None = ...

A list of ACM certificates.

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

When the list is truncated, this value is present and contains the value to use for the NextToken parameter in a subsequent pagination request.

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.