Skip to content

list_acme_accounts

list_acme_accounts(
    acme_endpoint_arn: AcmeEndpointArn,
    *,
    config_overrides: Optional[ACMClientConfig] = None,
    next_token: Optional[str] = None,
    max_results: Optional[int] = None,
) -> ListAcmeAccountsResponse

Retrieves a list of ACME accounts registered with the specified ACME endpoint. ACME accounts are created when clients use external account binding credentials to register.

Parameters:

  • next_token (Optional[str], default: None ) –

    A token for pagination.

  • max_results (Optional[int], default: None ) –

    The maximum number of results to return.

  • acme_endpoint_arn (AcmeEndpointArn) –

    The Amazon Resource Name (ARN) of the ACME endpoint.

Raises:

Source code in docs_src/capo_acm/_services/acm.py
def list_acme_accounts(
    self,
    acme_endpoint_arn: "capo_acm.types.acme_endpoint_arn.AcmeEndpointArn",
    *,
    config_overrides: Optional[ACMClientConfig] = None,
    next_token: Optional[str] = None,
    max_results: Optional[int] = None,
) -> "capo_acm.types.list_acme_accounts_response.ListAcmeAccountsResponse":
    """<p>Retrieves a list of ACME accounts registered with the specified ACME endpoint. ACME accounts are created when clients use external account binding credentials to register.</p>

    Args:
        next_token: <p>A token for pagination.</p>
        max_results: <p>The maximum number of results to return.</p>
        acme_endpoint_arn: <p>The Amazon Resource Name (ARN) of the ACME endpoint.</p>

    Raises:
        capo_acm.errors.access_denied_exception.AccessDeniedException: <p>You do not have access required to perform this action.</p>
        capo_acm.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception, or failure.</p>
        capo_acm.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified certificate cannot be found in the caller's account or the caller's account cannot be found.</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.list_acme_accounts_request.ListAcmeAccountsRequest]",
    ) -> OperationResponse[
        "capo_acm.types.list_acme_accounts_response.ListAcmeAccountsResponse"
    ]:
        import capo_acm._operations.certificate_manager.list_acme_accounts

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

    def _redact_output(
        output: "capo_acm.types.list_acme_accounts_response.ListAcmeAccountsResponse",
    ) -> dict[str, Any]:
        import capo_acm.types.list_acme_accounts_response

        return capo_acm.types.list_acme_accounts_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListAcmeAccounts", redact_output=_redact_output),
    )
    input_: capo_acm.types.list_acme_accounts_request.ListAcmeAccountsRequest = {
        "acme_endpoint_arn": acme_endpoint_arn
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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