search_certificates¶
Operation¶
search_certificates
async
¶
search_certificates(request: SearchCertificatesInput | SearchCertificatesInputDict, /, *, plugins: list[Plugin] | None = None) -> SearchCertificatesOutput
search_certificates(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[SearchCertificatesInputDict]) -> SearchCertificatesOutput
Retrieves a list of certificates matching search criteria. You can filter certificates by X.509 attributes and ACM specific properties like certificate status, type and renewal eligibility. This operation provides more flexible filtering than ListCertificates by supporting complex filter statements.
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 |
|---|---|
SearchCertificatesOutput
|
An instance of |
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¶
SearchCertificatesInput
dataclass
¶
Bases: _SerdeShape
Dataclass for SearchCertificatesInput structure.
Attributes¶
filter_statement
class-attribute
instance-attribute
¶
filter_statement: CertificateFilterStatement | None = ...
A filter statement that defines the search criteria. You can combine multiple filters using AND, OR, and NOT logical operators to create complex queries.
max_results
class-attribute
instance-attribute
¶
max_results: int = ...
The maximum number of results to return in the response. Default is 100.
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 = ...
Specifies the field to sort results by. Valid values are CREATED_AT, NOT_AFTER, STATUS, RENEWAL_STATUS, EXPORTED, IN_USE, NOT_BEFORE, KEY_ALGORITHM, TYPE, CERTIFICATE_ARN, COMMON_NAME, REVOKED_AT, RENEWAL_ELIGIBILITY, ISSUED_AT, MANAGED_BY, EXPORT_OPTION, VALIDATION_METHOD, and IMPORTED_AT.
Dictionaries¶
SearchCertificatesInputDict
¶
Bases: TypedDict
Dictionary form of SearchCertificatesInput.
Attributes¶
filter_statement
instance-attribute
¶
filter_statement: CertificateFilterStatement | CertificateFilterStatementDict | None
A filter statement that defines the search criteria. You can combine multiple filters using AND, OR, and NOT logical operators to create complex queries.
max_results
instance-attribute
¶
max_results: int | None
The maximum number of results to return in the response. Default is 100.
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. Valid values are CREATED_AT, NOT_AFTER, STATUS, RENEWAL_STATUS, EXPORTED, IN_USE, NOT_BEFORE, KEY_ALGORITHM, TYPE, CERTIFICATE_ARN, COMMON_NAME, REVOKED_AT, RENEWAL_ELIGIBILITY, ISSUED_AT, MANAGED_BY, EXPORT_OPTION, VALIDATION_METHOD, and IMPORTED_AT.
Output¶
SearchCertificatesOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for SearchCertificatesOutput structure.
Attributes¶
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
¶
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.
results
class-attribute
instance-attribute
¶
results: list[CertificateSearchResult] | None = ...
A list of certificate search results containing certificate ARNs, X.509 attributes, and ACM metadata.