Gets all detectors or a single detector if a detectorId is specified. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetDetectorsResponse as part of your request. A null pagination token fetches the records from the beginning.
Parameters:
Raises:
Source code in docs_src/capo_frauddetector/_services/async_fraud_detector.py
| async def get_detectors(
self,
*,
config_overrides: Optional[AsyncFraudDetectorClientConfig] = None,
detector_id: Optional["capo_frauddetector.types.identifier.identifier"] = None,
next_token: Optional["capo_frauddetector.types.string.string"] = None,
max_results: Optional[
"capo_frauddetector.types.detectors_max_results.DetectorsMaxResults"
] = None,
) -> "capo_frauddetector.types.get_detectors_result.GetDetectorsResult":
"""<p>Gets all detectors or a single detector if a <code>detectorId</code> is specified. This is a paginated API. If you provide a null <code>maxResults</code>, this action retrieves a maximum of 10 records per page. If you provide a <code>maxResults</code>, the value must be between 5 and 10. To get the next page results, provide the pagination token from the <code>GetDetectorsResponse</code> as part of your request. A null pagination token fetches the records from the beginning. </p>
Args:
detector_id: <p>The detector ID.</p>
next_token: <p>The next token for the subsequent request.</p>
max_results: <p>The maximum number of objects to return for the request.</p>
Raises:
capo_frauddetector.errors.access_denied_exception.AccessDeniedException: <p>An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as <code>PutExternalModel</code>, that specifies a role that is not in your account.</p>
capo_frauddetector.errors.internal_server_exception.InternalServerException: <p>An exception indicating an internal server error.</p>
capo_frauddetector.errors.resource_not_found_exception.ResourceNotFoundException: <p>An exception indicating the specified resource was not found.</p>
capo_frauddetector.errors.throttling_exception.ThrottlingException: <p>An exception indicating a throttling error.</p>
capo_frauddetector.errors.validation_exception.ValidationException: <p>An exception indicating a specified value is not allowed.</p>
capo_frauddetector.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_frauddetector.types.get_detectors_request.GetDetectorsRequest]",
) -> AsyncOperationResponse[
"capo_frauddetector.types.get_detectors_result.GetDetectorsResult"
]:
import capo_frauddetector._operations.aws_hawks_nest_service_facade.get_detectors
(
output,
http_response,
) = await capo_frauddetector._operations.aws_hawks_nest_service_facade.get_detectors.async_get_detectors(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("GetDetectors")
)
input_: capo_frauddetector.types.get_detectors_request.GetDetectorsRequest = {}
if detector_id is not None:
input_["detector_id"] = detector_id
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|