search_certificates ¶

def search_certificates(
    self,
    *,
    config_overrides: Optional[ACMClientConfig] = None,
    filter_statement: Optional[
        "capo_acm.types.certificate_filter_statement.CertificateFilterStatement"
    ] = None,
    max_results: Optional[
        "capo_acm.types.search_max_results.SearchMaxResults"
    ] = None,
    next_token: Optional["capo_acm.types.next_token.NextToken"] = None,
    sort_by: Optional[
        "capo_acm.types.search_certificates_sort_by.SearchCertificatesSortBy"
    ] = None,
    sort_order: Optional[
        "capo_acm.types.search_certificates_sort_order.SearchCertificatesSortOrder"
    ] = None,
) -> "capo_acm.types.search_certificates_response.SearchCertificatesResponse":
    """<p>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 <a>ListCertificates</a> by supporting complex filter statements.</p>

    Args:
        filter_statement: <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: <p>The maximum number of results to return in the response. Default is 100.</p>
        next_token: <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: <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: <p>Specifies the order of sorted results. Valid values are ASCENDING or DESCENDING.</p>

    Raises:
        capo_acm.errors.access_denied_exception.AccessDeniedException: <p>You do not have access required to perform this action.</p>
        capo_acm.errors.throttling_exception.ThrottlingException: <p>The request was denied because it exceeded a quota.</p>
        capo_acm.errors.validation_exception.ValidationException: <p>The supplied input failed to satisfy constraints of an Amazon Web Services service.</p>
        capo_acm.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_acm.types.search_certificates_request.SearchCertificatesRequest]",
    ) -> OperationResponse[
        "capo_acm.types.search_certificates_response.SearchCertificatesResponse"
    ]:
        import capo_acm._operations.certificate_manager.search_certificates

        output, http_response = (
            capo_acm._operations.certificate_manager.search_certificates.search_certificates(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SearchCertificates")
    )
    input_: capo_acm.types.search_certificates_request.SearchCertificatesRequest = {}
    if filter_statement is not None:
        input_["filter_statement"] = filter_statement
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if sort_order is not None:
        input_["sort_order"] = sort_order

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output