list_certificates ¶

def list_certificates(
    self,
    *,
    config_overrides: Optional[ACMClientConfig] = None,
    certificate_statuses: Optional[
        "capo_acm.types.certificate_statuses.CertificateStatuses"
    ] = None,
    certificate_key_pair_origins: Optional[
        "capo_acm.types.certificate_key_pair_origins.CertificateKeyPairOrigins"
    ] = None,
    includes: Optional["capo_acm.types.filters.Filters"] = None,
    next_token: Optional["capo_acm.types.next_token.NextToken"] = None,
    max_items: Optional["capo_acm.types.max_items.MaxItems"] = None,
    sort_by: Optional["capo_acm.types.sort_by.SortBy"] = None,
    sort_order: Optional["capo_acm.types.sort_order.SortOrder"] = None,
) -> "capo_acm.types.list_certificates_response.ListCertificatesResponse":
    """<p>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 <code>RSA_2048</code> certificates. For more information, see <a>Filters</a>.</p> <note> <p>By default, this action does not return certificates with a <code>CertificateKeyPairOrigin</code> of <code>ACME</code>. To include ACME certificates, specify <code>ACME</code> in the <code>CertificateKeyPairOrigins</code> filter.</p> </note>

    Args:
        certificate_statuses: <p>Filter the certificate list by status value.</p>
        certificate_key_pair_origins: <p>Filter the certificate list by certificate key pair origin. Specify one or more <code>CertificateKeyPairOrigin</code> values. Default filtering returns only certificates with key pair origin of <code>AWS_MANAGED</code> and <code>CUSTOMER_PROVIDED</code>.</p>
        includes: <p>Filter the certificate list. For more information, see the <a>Filters</a> structure.</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>
        max_items: <p>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 <code>NextToken</code> element is sent in the response. Use this <code>NextToken</code> value in a subsequent request to retrieve additional items.</p>
        sort_by: <p>Specifies the field to sort results by. If you specify <code>SortBy</code>, you must also specify <code>SortOrder</code>.</p>
        sort_order: <p>Specifies the order of sorted results. If you specify <code>SortOrder</code>, you must also specify <code>SortBy</code>.</p>

    Raises:
        capo_acm.errors.invalid_args_exception.InvalidArgsException: <p>One or more of request parameters specified is not valid.</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.list_certificates_request.ListCertificatesRequest]",
    ) -> OperationResponse[
        "capo_acm.types.list_certificates_response.ListCertificatesResponse"
    ]:
        import capo_acm._operations.certificate_manager.list_certificates

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListCertificates")
    )
    input_: capo_acm.types.list_certificates_request.ListCertificatesRequest = {}
    if certificate_statuses is not None:
        input_["certificate_statuses"] = certificate_statuses
    if certificate_key_pair_origins is not None:
        input_["certificate_key_pair_origins"] = certificate_key_pair_origins
    if includes is not None:
        input_["includes"] = includes
    if next_token is not None:
        input_["next_token"] = next_token
    if max_items is not None:
        input_["max_items"] = max_items
    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