list_anomaly_detectors ¶

def list_anomaly_detectors(
    self,
    workspace_id: "capo_amp.types.workspace_id.WorkspaceId",
    *,
    config_overrides: Optional[ampClientConfig] = None,
    alias: Optional[
        "capo_amp.types.anomaly_detector_alias.AnomalyDetectorAlias"
    ] = None,
    max_results: Optional[int] = None,
    next_token: Optional["capo_amp.types.pagination_token.PaginationToken"] = None,
) -> "capo_amp.types.list_anomaly_detectors_response.ListAnomalyDetectorsResponse":
    """<p>Returns a paginated list of anomaly detectors for a workspace with optional filtering by alias.</p>

    Args:
        workspace_id: <p>The identifier of the workspace containing the anomaly detectors to list.</p>
        alias: <p>Filters the results to anomaly detectors with the specified alias.</p>
        max_results: <p>The maximum number of results to return in a single call. Valid range is 1 to 1000.</p>
        next_token: <p>The pagination token to continue retrieving results.</p>

    Raises:
        capo_amp.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_amp.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred during the processing of the request.</p>
        capo_amp.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request references a resources that doesn't exist.</p>
        capo_amp.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_amp.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_amp.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_amp.types.list_anomaly_detectors_request.ListAnomalyDetectorsRequest]",
    ) -> OperationResponse[
        "capo_amp.types.list_anomaly_detectors_response.ListAnomalyDetectorsResponse"
    ]:
        import capo_amp._operations.amazon_prometheus_service.list_anomaly_detectors

        output, http_response = (
            capo_amp._operations.amazon_prometheus_service.list_anomaly_detectors.list_anomaly_detectors(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAnomalyDetectors")
    )
    input_: capo_amp.types.list_anomaly_detectors_request.ListAnomalyDetectorsRequest = {
        "workspace_id": workspace_id
    }
    if alias is not None:
        input_["alias"] = alias
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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