Skip to content

SearchCertificatesRequest

Source code in docs_src/capo_acm/types/search_certificates_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class SearchCertificatesRequest(TypedDict, closed=True):
    filter_statement: NotRequired[
        "capo_acm.types.certificate_filter_statement.CertificateFilterStatement"
    ]
    """<p>A filter statement that defines the search criteria. You can combine multiple filters using AND, OR, and NOT logical operators to create complex queries.</p>"""
    max_results: "capo_acm.types.search_max_results.SearchMaxResults"
    """<p>The maximum number of results to return in the response. Default is 100.</p>"""
    next_token: NotRequired["capo_acm.types.next_token.NextToken"]
    """<p>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 <code>NextToken</code> from the response you just received.</p>"""
    sort_by: "capo_acm.types.search_certificates_sort_by.SearchCertificatesSortBy"
    """<p>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.</p>"""
    sort_order: (
        "capo_acm.types.search_certificates_sort_order.SearchCertificatesSortOrder"
    )
    """<p>Specifies the order of sorted results. Valid values are ASCENDING or DESCENDING.</p>"""

filter_statement instance-attribute 

filter_statement: NotRequired[CertificateFilterStatement]

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: SearchMaxResults

The maximum number of results to return in the response. Default is 100.

next_token instance-attribute 

next_token: NotRequired[NextToken]

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: SearchCertificatesSortBy

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.

sort_order instance-attribute 

sort_order: SearchCertificatesSortOrder

Specifies the order of sorted results. Valid values are ASCENDING or DESCENDING.